microgrid 0.1.0__tar.gz → 0.1.2__tar.gz

{microgrid-0.1.0 → microgrid-0.1.2}/CHANGELOG.md

@@ -4,6 +4,22 @@ Each user-visible change, under the release it ships in.
 
 ## [Unreleased]
 
+## [0.1.2] - 2026-10-18
+
+### Fixed (documentation)
+
+- The documentation's home page: *What makes it different* is *How it prices*; the
+  parts name `microgrid.plant`, the plant model, apart from `microgrid.engine`; the
+  line saying to install from the git repository is gone (it is on PyPI).
+
+## [0.1.1] - 2026-10-18
+
+### Changed (documentation)
+
+- The README, the documentation's home page and the package's summary say what the
+  library takes and returns, without the "data in, data out" slogan; why it does no I/O
+  is in *Scope* (`docs/methodology/scope.md`).
+
 ## [0.1.0] - 2026-10-18
 
 The first version, under the MIT license.

{microgrid-0.1.0 → microgrid-0.1.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.5
 Name: microgrid
-Version: 0.1.0
-Summary: A plant model and marginal energy prices for a solar + battery microgrid: data in, data out
+Version: 0.1.2
+Summary: A plant model and marginal energy prices for a solar + battery microgrid
 Project-URL: Homepage, https://github.com/eman/microgrid
 Project-URL: Documentation, https://eman.github.io/microgrid/
 Project-URL: Source, https://github.com/eman/microgrid
@@ -33,12 +33,10 @@ produces **marginal energy prices** from it (`microgrid.engine`): what one more
 costs, slot by slot over a horizon, and the value of energy by source. The plant model
 also stands alone, without the price code.
 
-- **Data in, data out.** No I/O: a client hands in the plant's configuration
-  (`plant/2`) and its inputs as time series (prices, PV and load forecasts, the
-  meters), and gets prices, regimes, certainties and surplus back.
-- **The plant model** takes its topology as configuration: PV of either coupling,
-  a battery on its own inverter or on a hybrid's DC bus, loads on either bus, the
-  grid's limits and charge windows.
+You describe the plant (`plant/2`: PV of either coupling, a battery on its own inverter
+or on a hybrid's DC bus, loads on either bus, the grid's limits and charge windows) and
+give it its inputs as time series (prices, PV and load forecasts, the meters); it returns
+prices, regimes, certainties and surplus for each slot.
 
 The documentation is in [`docs/`](https://github.com/eman/microgrid/blob/main/docs/index.md),
 published with each release at `https://eman.github.io/microgrid/`:
@@ -59,7 +57,7 @@ model: pin the minor release you tested with (`microgrid ~= 0.1.0`,
 
 `microgrid` (`microgrid.cli`, installed with the library) runs it on a dataset
 (`dataset/1`: a directory of series and the plant's and engine's files), so it needs no
-plant at hand. `microgrid.cli` reads the files; the engine still does no I/O. The example
+plant at hand. The example
 dataset (`examples/dataset`) is one synthetic week of the library's example plant in
 Europe/Berlin, the DST change on 2026-10-25 inside it:
 

{microgrid-0.1.0 → microgrid-0.1.2}/README.md

@@ -5,12 +5,10 @@ produces **marginal energy prices** from it (`microgrid.engine`): what one more
 costs, slot by slot over a horizon, and the value of energy by source. The plant model
 also stands alone, without the price code.
 
-- **Data in, data out.** No I/O: a client hands in the plant's configuration
-  (`plant/2`) and its inputs as time series (prices, PV and load forecasts, the
-  meters), and gets prices, regimes, certainties and surplus back.
-- **The plant model** takes its topology as configuration: PV of either coupling,
-  a battery on its own inverter or on a hybrid's DC bus, loads on either bus, the
-  grid's limits and charge windows.
+You describe the plant (`plant/2`: PV of either coupling, a battery on its own inverter
+or on a hybrid's DC bus, loads on either bus, the grid's limits and charge windows) and
+give it its inputs as time series (prices, PV and load forecasts, the meters); it returns
+prices, regimes, certainties and surplus for each slot.
 
 The documentation is in [`docs/`](https://github.com/eman/microgrid/blob/main/docs/index.md),
 published with each release at `https://eman.github.io/microgrid/`:
@@ -31,7 +29,7 @@ model: pin the minor release you tested with (`microgrid ~= 0.1.0`,
 
 `microgrid` (`microgrid.cli`, installed with the library) runs it on a dataset
 (`dataset/1`: a directory of series and the plant's and engine's files), so it needs no
-plant at hand. `microgrid.cli` reads the files; the engine still does no I/O. The example
+plant at hand. The example
 dataset (`examples/dataset`) is one synthetic week of the library's example plant in
 Europe/Berlin, the DST change on 2026-10-25 inside it:
 

{microgrid-0.1.0 → microgrid-0.1.2}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "hatchling.build"
 
 [project]
 name = "microgrid"
-version = "0.1.0"
-description = "A plant model and marginal energy prices for a solar + battery microgrid: data in, data out"
+version = "0.1.2"
+description = "A plant model and marginal energy prices for a solar + battery microgrid"
 readme = "README.md"
 requires-python = ">=3.14"
 license = "MIT"

{microgrid-0.1.0 → microgrid-0.1.2}/src/microgrid/__init__.py

@@ -1,9 +1,8 @@
 """microgrid: a solar + battery plant modelled, and its marginal energy prices.
 
 - :mod:`microgrid.plant`: the plant model and its simulator, on their own: a plant
-  described as data (``plant/2``), projected slot by slot. No I/O.
-- :mod:`microgrid.engine`: the marginal prices, a client of the plant model. Data in,
-  data out: no I/O.
+  described as data (``plant/2``), projected slot by slot.
+- :mod:`microgrid.engine`: the marginal prices, a client of the plant model.
 - :mod:`microgrid.cli`: the ``microgrid`` command, the library run on a dataset's files
   (``dataset/1``) or on a site's live sources (``sources/1``, the ``sources`` extra). A
   client of the public names, as any other.

{microgrid-0.1.0 → microgrid-0.1.2}/src/microgrid/engine/__init__.py

@@ -1,8 +1,6 @@
 """The microgrid engine: the model that values energy by time and source.
 
-Pure: no I/O, no network, no wire format. Clients (the CLI, a
-service, scripts) hand it data and get data back; it has
-no dependencies. The contract is what this module
+It has no dependencies. The contract is what this module
 exports; every other module (``_value``, ``plant._paths``, ...) is private.
 
     engine = Engine(EngineConfig(plant=plant.Plant(plant.PlantConfig(tz=..., pv=..., ...))))

{microgrid-0.1.0 → microgrid-0.1.2}/src/microgrid/plant/__init__.py

@@ -1,7 +1,7 @@
 """The plant model and its simulator, on their own (``microgrid.plant``).
 
-A plant is described by a :class:`PlantConfig` (``plant/2``), given as data: the model
-does no I/O to receive it. :class:`Plant` is that plant behind the port
+A plant is described by a :class:`PlantConfig` (``plant/2``), given as data.
+:class:`Plant` is that plant behind the port
 (:class:`~microgrid.plant.port.PlantModel`): one configurable model, not one class per
 topology, running every configuration through one dispatch. ``Plant.project`` projects
 the slots it is given from a state of charge, PV and load, and returns their flows