microgrid 0.1.2__tar.gz → 0.1.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (136) hide show
  1. {microgrid-0.1.2 → microgrid-0.1.3}/CHANGELOG.md +8 -0
  2. {microgrid-0.1.2 → microgrid-0.1.3}/PKG-INFO +2 -3
  3. {microgrid-0.1.2 → microgrid-0.1.3}/README.md +1 -2
  4. {microgrid-0.1.2 → microgrid-0.1.3}/pyproject.toml +1 -1
  5. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/__init__.py +1 -1
  6. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/plant/__init__.py +1 -1
  7. {microgrid-0.1.2 → microgrid-0.1.3}/.gitignore +0 -0
  8. {microgrid-0.1.2 → microgrid-0.1.3}/LICENSE +0 -0
  9. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/engine.toml +0 -0
  10. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/expected/ledger-2026-10-21.txt +0 -0
  11. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/expected/live-2026-10-25.txt +0 -0
  12. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/expected/replay-2026-10-22.txt +0 -0
  13. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/expected/value-2026-10-22T13-03.txt +0 -0
  14. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/expected/value-2026-10-25T02-30.txt +0 -0
  15. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/forecasts/load_forecast.json +0 -0
  16. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/forecasts/prices.json +0 -0
  17. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/forecasts/pv_forecast.json +0 -0
  18. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/manifest.json +0 -0
  19. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/plant.toml +0 -0
  20. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/series/battery.json +0 -0
  21. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/series/battery_first.json +0 -0
  22. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/series/export_price.json +0 -0
  23. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/series/grid.json +0 -0
  24. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/series/heartbeat.json +0 -0
  25. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/series/house.json +0 -0
  26. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/series/import_price.json +0 -0
  27. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/series/inverter.json +0 -0
  28. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/series/pv.json +0 -0
  29. {microgrid-0.1.2 → microgrid-0.1.3}/examples/dataset/series/soc.json +0 -0
  30. {microgrid-0.1.2 → microgrid-0.1.3}/scripts/ci_local.sh +0 -0
  31. {microgrid-0.1.2 → microgrid-0.1.3}/scripts/griffe_microgrid.py +0 -0
  32. {microgrid-0.1.2 → microgrid-0.1.3}/scripts/install-hooks.sh +0 -0
  33. {microgrid-0.1.2 → microgrid-0.1.3}/scripts/make_example_dataset.py +0 -0
  34. {microgrid-0.1.2 → microgrid-0.1.3}/scripts/make_expected_outputs.py +0 -0
  35. {microgrid-0.1.2 → microgrid-0.1.3}/scripts/mkdocs_hooks.py +0 -0
  36. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/_checks.py +0 -0
  37. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/__init__.py +0 -0
  38. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/check_plant.py +0 -0
  39. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/dataset.py +0 -0
  40. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/evaluation.py +0 -0
  41. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/fit_battery.py +0 -0
  42. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/history.py +0 -0
  43. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/inputs.py +0 -0
  44. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/main.py +0 -0
  45. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/offline.py +0 -0
  46. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/replay.py +0 -0
  47. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/sources/__init__.py +0 -0
  48. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/sources/config.py +0 -0
  49. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/sources/emhass.py +0 -0
  50. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/sources/entity.py +0 -0
  51. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/sources/fetch.py +0 -0
  52. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/sources/home_assistant.py +0 -0
  53. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/sources/predbat.py +0 -0
  54. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/sources/read.py +0 -0
  55. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/sources/solcast.py +0 -0
  56. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/sources/tariffkit.py +0 -0
  57. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/cli/toml_text.py +0 -0
  58. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/__init__.py +0 -0
  59. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/_api.py +0 -0
  60. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/_assess.py +0 -0
  61. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/_engine_config.py +0 -0
  62. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/_inputs.py +0 -0
  63. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/_live.py +0 -0
  64. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/_stored.py +0 -0
  65. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/_supply.py +0 -0
  66. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/_surplus.py +0 -0
  67. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/_timeline.py +0 -0
  68. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/_value.py +0 -0
  69. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/analysis/__init__.py +0 -0
  70. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/analysis/ground_truth.py +0 -0
  71. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/analysis/scoring.py +0 -0
  72. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/extend.py +0 -0
  73. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/ledger.py +0 -0
  74. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/py.typed +0 -0
  75. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/schemas/valuation-2.schema.json +0 -0
  76. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/series.py +0 -0
  77. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/testing.py +0 -0
  78. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/engine/units.py +0 -0
  79. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/plant/_battery.py +0 -0
  80. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/plant/_config.py +0 -0
  81. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/plant/_meters.py +0 -0
  82. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/plant/_paths.py +0 -0
  83. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/plant/_plant.py +0 -0
  84. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/plant/examples.py +0 -0
  85. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/plant/flows.py +0 -0
  86. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/plant/port.py +0 -0
  87. {microgrid-0.1.2 → microgrid-0.1.3}/src/microgrid/py.typed +0 -0
  88. {microgrid-0.1.2 → microgrid-0.1.3}/tests/architecture.py +0 -0
  89. {microgrid-0.1.2 → microgrid-0.1.3}/tests/cli/makeup/engine.toml +0 -0
  90. {microgrid-0.1.2 → microgrid-0.1.3}/tests/cli/makeup/live-2026-10-25.txt +0 -0
  91. {microgrid-0.1.2 → microgrid-0.1.3}/tests/cli/makeup/replay-2026-10-22.txt +0 -0
  92. {microgrid-0.1.2 → microgrid-0.1.3}/tests/cli/makeup/value-2026-10-22T13-03.txt +0 -0
  93. {microgrid-0.1.2 → microgrid-0.1.3}/tests/cli/makeup/value-2026-10-25T02-30.txt +0 -0
  94. {microgrid-0.1.2 → microgrid-0.1.3}/tests/cli/test_dataset.py +0 -0
  95. {microgrid-0.1.2 → microgrid-0.1.3}/tests/cli/test_end_to_end.py +0 -0
  96. {microgrid-0.1.2 → microgrid-0.1.3}/tests/cli/test_evaluation_properties.py +0 -0
  97. {microgrid-0.1.2 → microgrid-0.1.3}/tests/cli/test_fit_battery.py +0 -0
  98. {microgrid-0.1.2 → microgrid-0.1.3}/tests/cli/test_history.py +0 -0
  99. {microgrid-0.1.2 → microgrid-0.1.3}/tests/cli/test_main.py +0 -0
  100. {microgrid-0.1.2 → microgrid-0.1.3}/tests/cli/test_sources.py +0 -0
  101. {microgrid-0.1.2 → microgrid-0.1.3}/tests/engine_fixtures.py +0 -0
  102. {microgrid-0.1.2 → microgrid-0.1.3}/tests/legacy_dispatch.py +0 -0
  103. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_api.py +0 -0
  104. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_architecture.py +0 -0
  105. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_assess.py +0 -0
  106. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_by_source.py +0 -0
  107. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_config.py +0 -0
  108. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_dc_loads.py +0 -0
  109. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_dispatch_parts.py +0 -0
  110. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_engine_config.py +0 -0
  111. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_examples.py +0 -0
  112. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_ground_truth.py +0 -0
  113. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_inputs.py +0 -0
  114. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_internals.py +0 -0
  115. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_ledger.py +0 -0
  116. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_ledger_properties.py +0 -0
  117. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_limits.py +0 -0
  118. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_live_core.py +0 -0
  119. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_meters.py +0 -0
  120. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_models.py +0 -0
  121. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_outputs.py +0 -0
  122. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_paths.py +0 -0
  123. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_plant.py +0 -0
  124. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_plant_properties.py +0 -0
  125. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_port.py +0 -0
  126. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_projection.py +0 -0
  127. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_pv_per_array.py +0 -0
  128. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_rule_on_port.py +0 -0
  129. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_scoring.py +0 -0
  130. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_series.py +0 -0
  131. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_stored_cost.py +0 -0
  132. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_supply_properties.py +0 -0
  133. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_timeline_properties.py +0 -0
  134. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_units.py +0 -0
  135. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_value.py +0 -0
  136. {microgrid-0.1.2 → microgrid-0.1.3}/tests/test_without_battery_or_pv.py +0 -0
@@ -4,6 +4,14 @@ Each user-visible change, under the release it ships in.
4
4
 
5
5
  ## [Unreleased]
6
6
 
7
+ ## [0.1.3] - 2026-10-18
8
+
9
+ ### Changed (documentation)
10
+
11
+ - The README, the documentation's home page, the install page and the package
12
+ docstrings no longer say that the plant model stands alone; how to use it without the
13
+ prices is its how-to (*Use the plant model on its own*).
14
+
7
15
  ## [0.1.2] - 2026-10-18
8
16
 
9
17
  ### Fixed (documentation)
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: microgrid
3
- Version: 0.1.2
3
+ Version: 0.1.3
4
4
  Summary: A plant model and marginal energy prices for a solar + battery microgrid
5
5
  Project-URL: Homepage, https://github.com/eman/microgrid
6
6
  Project-URL: Documentation, https://eman.github.io/microgrid/
@@ -30,8 +30,7 @@ Description-Content-Type: text/markdown
30
30
 
31
31
  `microgrid` is a library that models a solar + battery plant (`microgrid.plant`) and
32
32
  produces **marginal energy prices** from it (`microgrid.engine`): what one more kWh
33
- costs, slot by slot over a horizon, and the value of energy by source. The plant model
34
- also stands alone, without the price code.
33
+ costs, slot by slot over a horizon, and the value of energy by source.
35
34
 
36
35
  You describe the plant (`plant/2`: PV of either coupling, a battery on its own inverter
37
36
  or on a hybrid's DC bus, loads on either bus, the grid's limits and charge windows) and
@@ -2,8 +2,7 @@
2
2
 
3
3
  `microgrid` is a library that models a solar + battery plant (`microgrid.plant`) and
4
4
  produces **marginal energy prices** from it (`microgrid.engine`): what one more kWh
5
- costs, slot by slot over a horizon, and the value of energy by source. The plant model
6
- also stands alone, without the price code.
5
+ costs, slot by slot over a horizon, and the value of energy by source.
7
6
 
8
7
  You describe the plant (`plant/2`: PV of either coupling, a battery on its own inverter
9
8
  or on a hybrid's DC bus, loads on either bus, the grid's limits and charge windows) and
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "microgrid"
7
- version = "0.1.2"
7
+ version = "0.1.3"
8
8
  description = "A plant model and marginal energy prices for a solar + battery microgrid"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.14"
@@ -1,6 +1,6 @@
1
1
  """microgrid: a solar + battery plant modelled, and its marginal energy prices.
2
2
 
3
- - :mod:`microgrid.plant`: the plant model and its simulator, on their own: a plant
3
+ - :mod:`microgrid.plant`: the plant model and its simulator: a plant
4
4
  described as data (``plant/2``), projected slot by slot.
5
5
  - :mod:`microgrid.engine`: the marginal prices, a client of the plant model.
6
6
  - :mod:`microgrid.cli`: the ``microgrid`` command, the library run on a dataset's files
@@ -1,4 +1,4 @@
1
- """The plant model and its simulator, on their own (``microgrid.plant``).
1
+ """The plant model and its simulator (``microgrid.plant``).
2
2
 
3
3
  A plant is described by a :class:`PlantConfig` (``plant/2``), given as data.
4
4
  :class:`Plant` is that plant behind the port
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes