API reference¶
Everything listed here is the public API of 1.x and stays stable within it.
The names a script normally needs are importable from icgym directly.
| Page | Modules |
|---|---|
| Core | regions, water-filling, rules, fees, the batch game, oracles |
| Extensions | location game; generation, storage, and non-firm service (constant-theta and dispatched over the network's days); energy at the LMP |
| Networks and data | DC networks, region export, DCOPFRegion, bundled and on-demand data |
| Environments | PettingZoo, Gymnasium, and vectorized environments; sequential batches; the operator as an agent |
| Tools | rule comparison and benchmarks |
All the games use the same names:
- payoffs(strategies);
- payoff(i, x, strategies);
- best_response(i, strategies), which returns the strategy and its payoff;
- exploitability(strategies), which returns each applicant's gain from
deviating;
- best_response_dynamics(start), which returns
(strategies, history, rounds);
- predicted_equilibrium().