FinancialReport

class scml.scml2020.FinancialReport(agent_id, step, cash, assets, breach_prob, breach_level, is_bankrupt, agent_name)[source]

Bases: object

A report published periodically by the system showing the financial standing of an agent

Attributes Summary

agent_id

Agent ID

agent_name

Agent name for printing purposes

assets

Value of the products in the agent's inventory @ catalog prices.

breach_level

Sum of the agent's breach levels so far divided by the number of contracts it signed.

breach_prob

Number of times the agent breached a contract over the total number of contracts it signed.

cash

Cash in the agent's wallet.

is_bankrupt

Whether the agent is already bankrupt (i.e.

step

Simulation step at the beginning of which the report was published.

Attributes Documentation

agent_id: str

Agent ID

agent_name: str

Agent name for printing purposes

assets: int

Value of the products in the agent’s inventory @ catalog prices.

breach_level: float

Sum of the agent’s breach levels so far divided by the number of contracts it signed.

breach_prob: float

Number of times the agent breached a contract over the total number of contracts it signed.

cash: int

Cash in the agent’s wallet. Negative numbers indicate liabilities.

is_bankrupt: bool

Whether the agent is already bankrupt (i.e. incapable of doing any more transactions).

step: int

Simulation step at the beginning of which the report was published.