# NEMSweep

> NEMSweep is a free, open-source, deterministic engine for electricity grid dispatch, reliability assessment, battery sizing, system cost and emissions accounting. You describe a set of regions, each with its demand, weather, generation and storage, and a reliability standard; it dispatches them in merit order for every hour of the modelled period, grows battery storage in the regions that miss the standard, and reports the technical and economic result. It ships with no numbers of its own: every cost, carbon intensity, demand trace and weather year is supplied by whoever runs it. It is not a market model and not a forecast, and the cost it reports is the levelised cost of building and running the system per MWh served, not a retail bill.

## Start here

- [Agent guide (SKILL.md)](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/skills/nemsweep/SKILL.md): the single agent-facing guide. Install routes, preflight checks, starters, a smoke test, recipes, and how to read and report results.
- [Getting started](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/guide/index.md): prerequisites, install, workspace configuration and a first run.

## Running it

- [CLI reference](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/guide/cli.md): every command and how the data and output roots are chosen.
- [Running the container](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/guide/container.md): the published image, its two mounts, and pinning a run by digest.
- [Hosted starters](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/guide/synthetic-starters.md): the Simple synthetic grid and the Advanced NEM worked example, prepared by `--quick-start`.

## Configuring a study

- [Scenario configuration](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/guide/scenarios.md): every input field with its units, which inputs change dispatch and which change only cost, and recipes for changing one input or sweeping a cost parameter.
- [Sweeps](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/guide/sweeps.md): the definition format, merge-patch semantics, running selected points, and where the output lands.
- [Input bundles](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/guide/input-bundles.md): assembling demand and weather inputs from upstream sources.

## Reading results

- [Outputs and provenance](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/guide/outputs.md): the output tree, a field map with units, battery-only versus total storage fields, reliability units, how a missed target is signalled, the SLCoE definition, and what a result records about itself.
- [Glossary](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/guide/glossary.md): the terms and the quantities behind them.
- [CSV tables](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/guide/csv-tables.md): the star schema `--csv` writes alongside the JSON.

## Before quoting a figure

- [Limitations](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/assumptions/limitations.md): what the model's method does to its results, and in which direction.
- [Scenario parameters](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/assumptions/scenario-parameters.md): what the input values mean in the model and how to think about choosing them.

## Optional

- [Designing a study](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/exploring/index.md): choosing an axis and a baseline.
- [Custom grids](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/guide/custom-grids.md): a fully local synthetic grid, generated by a PowerShell script.
- [Concepts](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/docs/concepts/index.md): dispatch, storage sizing, transmission and economics as the engine implements them.
- [Repository root (README)](https://raw.githubusercontent.com/HasinthaAttanayake/NEMSweep/main/README.md): the three install routes and what the framework does and does not do.