Reference

The formats, the command and the API, each as the code defines it.

Formats. Each is versioned; a change that is not additive bumps the version.

Format	What it holds	Read and written by
dataset/1	a directory of series and forecasts, the inputs and what the meters recorded	microgrid.cli.dataset
plant/2	the plant's topology and parameters	PlantConfig.from_mapping, to_mapping
engine/2	how the price is computed	EngineConfig.from_mapping, to_mapping
sources/1	where each input comes from	microgrid.cli.sources.config.read_sources
valuation/2	the outputs	Valuation.to_mapping, LiveValue.to_mapping

The command. microgrid: every command and option.

Causes and kinds. What degraded and kind say.

Versions. What the release, the formats', the API's and the model's versions say, and what a release may change.

The API, generated from the docstrings, one page per public module. Every other module is private and may change without notice.

Module	Holds
microgrid.engine	Engine, EngineConfig, Inputs, the outputs and their enums, the versions
microgrid.engine.series	the form a client's data takes (Series, Forecast, Price, Quantiles), the operations on it, the slot grid
microgrid.engine.units	a series in the engine's units
microgrid.plant	PlantConfig and its parts, Plant, the examples
microgrid.engine.ledger	the battery's lots and their cost split
microgrid.engine.analysis.scoring	what a kWh realised, over metered flows
microgrid.engine.analysis.ground_truth	a plant model's projection against the meters
microgrid.engine.extend	the plant model port and the operations the engine is built from
microgrid.engine.testing	assert_plant_model_contract
microgrid.cli.dataset	dataset/1, read and written
microgrid.cli.inputs	a dataset as the engine's Inputs
microgrid.cli.history	a plant's recorded history, read through a port
microgrid.cli.offline	the library run on a dataset
microgrid.cli.sources.config	sources/1, read
microgrid.cli.sources.read	the inputs read now from the configured providers