API reference
Generated from the XML documentation comments in the source. Two assemblies are published here.
NEMSweep.Model
The framework: scenarios, the realised power system, dispatch, storage sizing, economics, and the
typed quantities everything is expressed in. This is the library you would reference to run the
model from your own code, with no command line. Region identifiers are free-form strings and the
grid model runs on a fixed one-hour timestep. The market-time offset is a run parameter, read from
the Scenario period bounds (Scenario.MarketTimeOffset, validated by MarketTime) and defaulting
to the National Electricity Market's UTC+10.
How to reference it. By project reference from a clone, or by referencing the built assembly. The licence is what grants the right: BSD-3-Clause permits use in your own software, including proprietary software, with attribution and no copyleft. Each built assembly carries that licence and the project URL in its own metadata, so a DLL on its own says what may be done with it.
NEMSweep.Model and NEMSweep.Contracts have no package dependencies of their own, which is what
makes them straightforward to embed.
Namespaces worth starting from:
| Namespace | What lives there |
|---|---|
NEMSweep.Model.Scenarios |
Scenario intent, and ScenarioDerivation which realises it |
NEMSweep.Model.Grid |
The realised system: regions, fleets, storage, interconnectors, and the technology vocabulary |
NEMSweep.Model.Simulation |
Dispatcher, dispatch evidence, reliability, and the IStoragePolicy extension point |
NEMSweep.Model.StorageSizing |
The sizing search, its options, and its results |
NEMSweep.Model.Economics |
Annuitisation and system costing |
NEMSweep.Model.Units |
Typed quantities: power, energy, distance, money and the cost rates. Dimensioned physical and monetary values cross domain boundaries as these types rather than as bare doubles. Dimensionless ratios, such as round-trip efficiency and the reliability target percentage, stay plain numbers |
NEMSweep.Model.Series, NEMSweep.Model.Weather, NEMSweep.Model.Generation |
Time series, weather resources, and the solar and wind power curves |
Internal types are not published. The dispatch run, the merit-order sort, the hydro pacer and the
max-flow algorithms are implementation detail behind Dispatcher; they are described in
Dispatch and the domain model reference.
NEMSweep.Contracts
The published artifact schema: the shapes of the JSON that a run writes and that any consumer reads. If you are working with NEMSweep's output rather than calling its model, this is the reference you want.
ArtifactSchemaVersions carries the current version of every artifact. SweepScalarCatalog names
every scalar a sweep publishes, with its label and unit.
See Outputs and provenance for how the artifacts fit together on disk.
Reading these pages
Documentation comments state units explicitly and, where a value is easily misread, say what it is not. Those negatives are load-bearing: several figures the model publishes are consistent bookkeeping allocations rather than physical measurements, and the distinction changes what a number can be used for.
Before drawing conclusions from any value here, read Limitations.