nlr-gat 0.1.0__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 (563) hide show
  1. nlr_gat-0.1.0/.github/workflows/release.yml +69 -0
  2. nlr_gat-0.1.0/.github/workflows/sienna-fixture-refresh.yml +159 -0
  3. nlr_gat-0.1.0/.github/workflows/sphinx.yml +99 -0
  4. nlr_gat-0.1.0/.github/workflows/tests.yml +195 -0
  5. nlr_gat-0.1.0/.gitignore +173 -0
  6. nlr_gat-0.1.0/.vscode/settings.json +7 -0
  7. nlr_gat-0.1.0/DISCLAIMER.md +1 -0
  8. nlr_gat-0.1.0/LICENSE +28 -0
  9. nlr_gat-0.1.0/Makefile +49 -0
  10. nlr_gat-0.1.0/PKG-INFO +196 -0
  11. nlr_gat-0.1.0/README.md +104 -0
  12. nlr_gat-0.1.0/docker/sienna/Dockerfile +35 -0
  13. nlr_gat-0.1.0/docker/sienna/Manifest.v4.toml +1199 -0
  14. nlr_gat-0.1.0/docker/sienna/Manifest.v5.toml +1347 -0
  15. nlr_gat-0.1.0/docker/sienna/Project.toml +17 -0
  16. nlr_gat-0.1.0/docker/sienna/README.md +123 -0
  17. nlr_gat-0.1.0/docker/sienna/generate.jl +189 -0
  18. nlr_gat-0.1.0/docs/.nojekyll +0 -0
  19. nlr_gat-0.1.0/docs/Makefile +20 -0
  20. nlr_gat-0.1.0/docs/gat_examples/01_dispatch_annual_system.py +34 -0
  21. nlr_gat-0.1.0/docs/gat_examples/02_dispatch_monthly_system.py +31 -0
  22. nlr_gat-0.1.0/docs/gat_examples/03_dispatch_area_facets.py +30 -0
  23. nlr_gat-0.1.0/docs/gat_examples/04_dispatch_window_peak_min.py +38 -0
  24. nlr_gat-0.1.0/docs/gat_examples/05_dispatch_mean_hourly.py +28 -0
  25. nlr_gat-0.1.0/docs/gat_examples/06_curtailment_annual.py +37 -0
  26. nlr_gat-0.1.0/docs/gat_examples/07_capacity_overview.py +31 -0
  27. nlr_gat-0.1.0/docs/gat_examples/08_load_heatmap.py +41 -0
  28. nlr_gat-0.1.0/docs/gat_examples/09_transmission_loading.py +55 -0
  29. nlr_gat-0.1.0/docs/gat_examples/GALLERY_HEADER.md +39 -0
  30. nlr_gat-0.1.0/docs/make.bat +35 -0
  31. nlr_gat-0.1.0/docs/simulation_discovery.md +361 -0
  32. nlr_gat-0.1.0/docs/source/CHANGELOG.md +130 -0
  33. nlr_gat-0.1.0/docs/source/api/Configuration/colors.md +25 -0
  34. nlr_gat-0.1.0/docs/source/api/Configuration/general.md +27 -0
  35. nlr_gat-0.1.0/docs/source/api/Configuration/scenario_config.md +36 -0
  36. nlr_gat-0.1.0/docs/source/api/Configuration/technology_area.md +35 -0
  37. nlr_gat-0.1.0/docs/source/api/Parsers/Plexos.md +10 -0
  38. nlr_gat-0.1.0/docs/source/api/Parsers/Sienna.md +25 -0
  39. nlr_gat-0.1.0/docs/source/api/Plots/dispatch.md +16 -0
  40. nlr_gat-0.1.0/docs/source/api/Plots/scenario.md +32 -0
  41. nlr_gat-0.1.0/docs/source/api/Plots/transmission.md +7 -0
  42. nlr_gat-0.1.0/docs/source/api/ScenarioObjects/BaseScenario.md +6 -0
  43. nlr_gat-0.1.0/docs/source/api/ScenarioObjects/EGRET.md +6 -0
  44. nlr_gat-0.1.0/docs/source/api/ScenarioObjects/MultiScenario.md +42 -0
  45. nlr_gat-0.1.0/docs/source/api/ScenarioObjects/Plexos.md +8 -0
  46. nlr_gat-0.1.0/docs/source/api/ScenarioObjects/ReEDS.md +8 -0
  47. nlr_gat-0.1.0/docs/source/api/ScenarioObjects/SiennaScenario.md +6 -0
  48. nlr_gat-0.1.0/docs/source/api/cli/commands.md +33 -0
  49. nlr_gat-0.1.0/docs/source/architecture/base_system.md +423 -0
  50. nlr_gat-0.1.0/docs/source/architecture/v1_migration_pattern.md +338 -0
  51. nlr_gat-0.1.0/docs/source/cli_commands.md +989 -0
  52. nlr_gat-0.1.0/docs/source/cli_project_management.md +647 -0
  53. nlr_gat-0.1.0/docs/source/cli_quick_reference.md +433 -0
  54. nlr_gat-0.1.0/docs/source/conf.py +119 -0
  55. nlr_gat-0.1.0/docs/source/diagrams/mapping.drawio +139 -0
  56. nlr_gat-0.1.0/docs/source/diagrams/mapping.png +0 -0
  57. nlr_gat-0.1.0/docs/source/examples/plugin/plot.py +135 -0
  58. nlr_gat-0.1.0/docs/source/examples/plugin/setup.py +24 -0
  59. nlr_gat-0.1.0/docs/source/extending_plots.md +255 -0
  60. nlr_gat-0.1.0/docs/source/index.md +308 -0
  61. nlr_gat-0.1.0/docs/source/legacy_handler_deprecation.md +104 -0
  62. nlr_gat-0.1.0/docs/source/loading_single_simulation_file.md +202 -0
  63. nlr_gat-0.1.0/docs/source/migration_v1.md +457 -0
  64. nlr_gat-0.1.0/docs/source/modules/generated/backreferences_all.json +1 -0
  65. nlr_gat-0.1.0/docs/source/modules/generated/gat.config.examples +0 -0
  66. nlr_gat-0.1.0/docs/source/modules/generated/gat.config.gatConfig.examples +0 -0
  67. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.parsers.examples +0 -0
  68. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.BaseModel.examples +0 -0
  69. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.Path.examples +0 -0
  70. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaH5Parser.examples +0 -0
  71. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaH5Parser.get_attributes.examples +0 -0
  72. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaH5Parser.get_dataset.examples +0 -0
  73. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaH5Parser.get_decision_model_base_power.examples +0 -0
  74. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaH5Parser.get_raw_dataset.examples +0 -0
  75. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaH5Parser.list_datasets.examples +0 -0
  76. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaH5Parser.timestamps.examples +0 -0
  77. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaModelConfig.examples +0 -0
  78. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaModelConfig.model_config.examples +0 -0
  79. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationAggregator.examples +0 -0
  80. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationAggregator.get_dataset.examples +0 -0
  81. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationAggregator.list_datasets.examples +0 -0
  82. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationAggregator.read_attributes.examples +0 -0
  83. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationAggregator.read_dataset.examples +0 -0
  84. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationConfig.examples +0 -0
  85. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationConfig.model_config.examples +0 -0
  86. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationParser.examples +0 -0
  87. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationParser.get_attributes.examples +0 -0
  88. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationParser.get_dataset.examples +0 -0
  89. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationParser.get_decision_model_base_power.examples +0 -0
  90. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationParser.get_raw_dataset.examples +0 -0
  91. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationParser.list_datasets.examples +0 -0
  92. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationParser.read_attributes.examples +0 -0
  93. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationParser.read_dataset.examples +0 -0
  94. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSimulationParser.timestamps.examples +0 -0
  95. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSystemParser.examples +0 -0
  96. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSystemParser.get_bus_area_relation.examples +0 -0
  97. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSystemParser.get_component.examples +0 -0
  98. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSystemParser.get_component_bus_relation.examples +0 -0
  99. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSystemParser.get_component_data.examples +0 -0
  100. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSystemParser.get_component_types.examples +0 -0
  101. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSystemParser.list_component_types.examples +0 -0
  102. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.SiennaSystemParser.list_components.examples +0 -0
  103. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.combine_frames_skip_prev.examples +0 -0
  104. nlr_gat-0.1.0/docs/source/modules/generated/gat.datahelpers.sienna.examples +0 -0
  105. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.Technology.examples +0 -0
  106. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.ceil.examples +0 -0
  107. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.create_flat_facet_axes.examples +0 -0
  108. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.create_marker_legend.examples +0 -0
  109. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.create_tech_legend.examples +0 -0
  110. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.examples +0 -0
  111. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.facet_dispatch_windows.examples +0 -0
  112. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.get_gen_color_map.examples +0 -0
  113. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.order_columns_colors.examples +0 -0
  114. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.plot_annual_area_curtailment_stack.examples +0 -0
  115. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.plot_annual_area_dispatch_stack.examples +0 -0
  116. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.plot_annual_system_curtailment_stack.examples +0 -0
  117. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.plot_annual_system_dispatch_stack.examples +0 -0
  118. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.plot_dispatch_stack_bar.examples +0 -0
  119. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.plot_min_demand_window.examples +0 -0
  120. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.plot_monthly_system_curtailment_stack.examples +0 -0
  121. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.plot_monthly_system_dispatch_stack.examples +0 -0
  122. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.plot_peak_demand_window.examples +0 -0
  123. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.plot_stacked_area_window.examples +0 -0
  124. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.plot_stacked_component_area.examples +0 -0
  125. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.plot_stacked_component_bar.examples +0 -0
  126. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.scale_up_down.examples +0 -0
  127. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.sqrt.examples +0 -0
  128. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.dispatch.trim_axs.examples +0 -0
  129. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.BaseScenario.examples +0 -0
  130. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.Palette.examples +0 -0
  131. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.PlexosScenario.examples +0 -0
  132. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.SiennaScenario.examples +0 -0
  133. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.convert_units.examples +0 -0
  134. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.create_load_handles.examples +0 -0
  135. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.examples +0 -0
  136. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.order_columns_colors.examples +0 -0
  137. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.plot_component_donut.examples +0 -0
  138. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.plot_function.examples +0 -0
  139. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.plot_minmax_area_demand_windows.examples +0 -0
  140. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.plot_minmax_system_demand_windows.examples +0 -0
  141. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.plot_stacked_component_area.examples +0 -0
  142. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.plot_stacked_component_bar.examples +0 -0
  143. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.generation_plots.plot_stacked_generation_window.examples +0 -0
  144. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.Any.examples +0 -0
  145. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.BaseScenario.examples +0 -0
  146. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.EGRETScenario.examples +0 -0
  147. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.FileScenario.examples +0 -0
  148. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.MultiScenario.examples +0 -0
  149. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.PlexosScenario.examples +0 -0
  150. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.ReEDsScenario.examples +0 -0
  151. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.SiennaScenario.examples +0 -0
  152. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.create_marker_legend.examples +0 -0
  153. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.create_tech_legend.examples +0 -0
  154. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.examples +0 -0
  155. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.map_system_capacity.examples +0 -0
  156. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.plot_function.examples +0 -0
  157. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.system_plots.plot_generation_capacities.examples +0 -0
  158. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.Technology.examples +0 -0
  159. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.ceil.examples +0 -0
  160. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.create_flat_facet_axes.examples +0 -0
  161. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.create_marker_legend.examples +0 -0
  162. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.create_tech_legend.examples +0 -0
  163. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.examples +0 -0
  164. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.get_gen_color_map.examples +0 -0
  165. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.order_columns_colors.examples +0 -0
  166. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.plot_flow.examples +0 -0
  167. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.plot_hourly_box_monthly.examples +0 -0
  168. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.plot_hourly_boxplot.examples +0 -0
  169. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.plot_lines_utilization.examples +0 -0
  170. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.plot_loading_ranked.examples +0 -0
  171. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.plot_ranked_series.examples +0 -0
  172. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.plot_utilization.examples +0 -0
  173. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.scale_up_down.examples +0 -0
  174. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.sqrt.examples +0 -0
  175. nlr_gat-0.1.0/docs/source/modules/generated/gat.quickplots.transmission.trim_axs.examples +0 -0
  176. nlr_gat-0.1.0/docs/source/modules/generated/gat.registry.Any.examples +0 -0
  177. nlr_gat-0.1.0/docs/source/modules/generated/gat.registry.Path.examples +0 -0
  178. nlr_gat-0.1.0/docs/source/modules/generated/gat.registry.discover_all_plots.examples +0 -0
  179. nlr_gat-0.1.0/docs/source/modules/generated/gat.registry.discover_external_plots.examples +0 -0
  180. nlr_gat-0.1.0/docs/source/modules/generated/gat.registry.discover_internal_plots.examples +0 -0
  181. nlr_gat-0.1.0/docs/source/modules/generated/gat.registry.examples +0 -0
  182. nlr_gat-0.1.0/docs/source/modules/generated/gat.registry.get_plot_function.examples +0 -0
  183. nlr_gat-0.1.0/docs/source/modules/generated/gat.registry.get_plot_names.examples +0 -0
  184. nlr_gat-0.1.0/docs/source/modules/generated/gat.registry.get_plots.examples +0 -0
  185. nlr_gat-0.1.0/docs/source/modules/generated/gat.registry.plot_function.examples +0 -0
  186. nlr_gat-0.1.0/docs/source/modules/generated/gat.registry.wraps.examples +0 -0
  187. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.ABC.examples +0 -0
  188. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.AggregateDataset.examples +0 -0
  189. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseModel.examples +0 -0
  190. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.area.examples +0 -0
  191. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.display_name.examples +0 -0
  192. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.examples +0 -0
  193. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.from_config.examples +0 -0
  194. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.gen_area_map.examples +0 -0
  195. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.generator_technology_map.examples +0 -0
  196. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_area_charging.examples +0 -0
  197. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_area_curtailment_aggregates.examples +0 -0
  198. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_area_dispatch.examples +0 -0
  199. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_area_load.examples +0 -0
  200. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_area_tech_aggregates.examples +0 -0
  201. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_area_unserved.examples +0 -0
  202. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_availability.examples +0 -0
  203. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_availability_tech.examples +0 -0
  204. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_curtailment.examples +0 -0
  205. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_flow.examples +0 -0
  206. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_gen_and_curtailment.examples +0 -0
  207. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_generation.examples +0 -0
  208. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_generation_capacity.examples +0 -0
  209. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_generators_tech.examples +0 -0
  210. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_line_congestion_hours.examples +0 -0
  211. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_line_flow.examples +0 -0
  212. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_line_loading.examples +0 -0
  213. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_line_utilization.examples +0 -0
  214. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_load.examples +0 -0
  215. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_peak_stats.examples +0 -0
  216. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_production_cost.examples +0 -0
  217. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_production_cost_tech.examples +0 -0
  218. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_storage_charging.examples +0 -0
  219. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_system_charging.examples +0 -0
  220. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_system_dispatch.examples +0 -0
  221. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.get_unserved.examples +0 -0
  222. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.line_rating_map.examples +0 -0
  223. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.load_area_map.examples +0 -0
  224. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.load_includes_charging.examples +0 -0
  225. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.save_config.examples +0 -0
  226. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.tech_simple.examples +0 -0
  227. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.BaseScenario.to_config.examples +0 -0
  228. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.DatasetConfig.examples +0 -0
  229. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.Field.examples +0 -0
  230. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.Node.examples +0 -0
  231. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.ProcessPoolExecutor.examples +0 -0
  232. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.RawDataset.examples +0 -0
  233. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.RelationSource.examples +0 -0
  234. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.ScenarioConfig.examples +0 -0
  235. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.Technology.examples +0 -0
  236. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.abstractmethod.examples +0 -0
  237. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.agg_plexos_dataset.examples +0 -0
  238. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.agg_plexos_parallel.examples +0 -0
  239. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.as_completed.examples +0 -0
  240. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.calc_congestion.examples +0 -0
  241. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.calc_curtailment.examples +0 -0
  242. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.calc_loading.examples +0 -0
  243. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.calc_ramp_rate.examples +0 -0
  244. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.combine_frames_skip_prev.examples +0 -0
  245. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.create_tech_mappings.examples +0 -0
  246. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.examples +0 -0
  247. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.extract_h5_data.examples +0 -0
  248. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.extract_h5_group.examples +0 -0
  249. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.field_validator.examples +0 -0
  250. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.fill_missing_loads.examples +0 -0
  251. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.get_peak_stats.examples +0 -0
  252. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.glob.examples +0 -0
  253. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.iglob.examples +0 -0
  254. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.load_map.examples +0 -0
  255. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.base.lru_cache.examples +0 -0
  256. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.egret.BaseScenario.examples +0 -0
  257. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.egret.EGRETScenario.examples +0 -0
  258. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.egret.EGRETScenario.get_gen_area_map.examples +0 -0
  259. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.egret.EGRETScenario.get_gen_tech_map.examples +0 -0
  260. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.egret.EGRETScenario.get_generator_dataframe.examples +0 -0
  261. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.egret.EGRETScenario.get_generator_map.examples +0 -0
  262. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.egret.EGRETScenario.get_raw_generators.examples +0 -0
  263. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.egret.EGRETScenario.list_simulation_files.examples +0 -0
  264. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.egret.examples +0 -0
  265. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.egret.load_map.examples +0 -0
  266. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.file_scenario.examples +0 -0
  267. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.BaseScenario.examples +0 -0
  268. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.add_scenario.examples +0 -0
  269. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.examples +0 -0
  270. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.get_area_charging.examples +0 -0
  271. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.get_area_dispatch.examples +0 -0
  272. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.get_area_unserved.examples +0 -0
  273. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.get_availability.examples +0 -0
  274. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.get_generation.examples +0 -0
  275. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.get_generation_capacity.examples +0 -0
  276. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.get_generators_tech.examples +0 -0
  277. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.get_line_flow.examples +0 -0
  278. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.get_load.examples +0 -0
  279. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.get_production_cost.examples +0 -0
  280. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.get_storage_charging.examples +0 -0
  281. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.get_system_dispatch.examples +0 -0
  282. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.MultiScenario.get_unserved.examples +0 -0
  283. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.multi.examples +0 -0
  284. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.BaseScenario.examples +0 -0
  285. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.examples +0 -0
  286. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.generate_gen_area_map.examples +0 -0
  287. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.generate_line_rating_map.examples +0 -0
  288. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.generate_map.examples +0 -0
  289. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.generate_tech_map.examples +0 -0
  290. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.generator_technology_map.examples +0 -0
  291. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.get_availability.examples +0 -0
  292. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.get_generation.examples +0 -0
  293. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.get_generation_capacity.examples +0 -0
  294. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.get_line_flow.examples +0 -0
  295. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.get_load.examples +0 -0
  296. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.get_plexos_h5map.examples +0 -0
  297. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.get_production_cost.examples +0 -0
  298. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.get_storage_charging.examples +0 -0
  299. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.get_unserved.examples +0 -0
  300. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.PlexosScenario.set_area_map.examples +0 -0
  301. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.ProcessPoolExecutor.examples +0 -0
  302. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.ScenarioConfig.examples +0 -0
  303. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.TechnologyMapping.examples +0 -0
  304. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.agg_plexos_dataset.examples +0 -0
  305. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.agg_plexos_parallel.examples +0 -0
  306. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.as_completed.examples +0 -0
  307. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.combine_frames_skip_prev.examples +0 -0
  308. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.examples +0 -0
  309. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.extract_h5_data.examples +0 -0
  310. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.extract_h5_group.examples +0 -0
  311. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.plexos.iglob.examples +0 -0
  312. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.BaseScenario.examples +0 -0
  313. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.examples +0 -0
  314. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.generator_technology_map.examples +0 -0
  315. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_area_dispatch.examples +0 -0
  316. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_area_load.examples +0 -0
  317. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_availability.examples +0 -0
  318. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_availability_tech.examples +0 -0
  319. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_gen_and_curtailment.examples +0 -0
  320. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_generation.examples +0 -0
  321. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_generation_capacity.examples +0 -0
  322. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_generators_tech.examples +0 -0
  323. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_installed_capacity.examples +0 -0
  324. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_ivrt.examples +0 -0
  325. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_line_flow.examples +0 -0
  326. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_load.examples +0 -0
  327. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_production_cost.examples +0 -0
  328. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_regional_curtailment.examples +0 -0
  329. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_storage_charging.examples +0 -0
  330. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.ReEDsScenario.get_unserved.examples +0 -0
  331. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.reeds.examples +0 -0
  332. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.BaseScenario.examples +0 -0
  333. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.MultiScenario.examples +0 -0
  334. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.ScenarioConfig.examples +0 -0
  335. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.area.examples +0 -0
  336. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.copy.examples +0 -0
  337. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.examples +0 -0
  338. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.from_simulation_models.examples +0 -0
  339. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.generator_technology_map.examples +0 -0
  340. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_area_interchange.examples +0 -0
  341. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_area_unserved.examples +0 -0
  342. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_availability.examples +0 -0
  343. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_gen_area_map.examples +0 -0
  344. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_generation.examples +0 -0
  345. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_generation_capacity.examples +0 -0
  346. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_line_flow.examples +0 -0
  347. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_line_rating_map.examples +0 -0
  348. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_load.examples +0 -0
  349. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_load_area_map.examples +0 -0
  350. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_production_cost.examples +0 -0
  351. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_raw_dataset.examples +0 -0
  352. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_storage_charging.examples +0 -0
  353. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_system_dispatch.examples +0 -0
  354. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_system_unserved.examples +0 -0
  355. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_tech_map.examples +0 -0
  356. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.get_unserved.examples +0 -0
  357. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaScenario.to_multiscenario.examples +0 -0
  358. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaSimulationAggregator.examples +0 -0
  359. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SiennaSystemParser.examples +0 -0
  360. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.SimulationAggregator.examples +0 -0
  361. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.examples +0 -0
  362. nlr_gat-0.1.0/docs/source/modules/generated/gat.scenariohandlers.sienna.fnmatch.examples +0 -0
  363. nlr_gat-0.1.0/docs/source/palette_generation.md +586 -0
  364. nlr_gat-0.1.0/docs/source/plugin_development_guide.md +651 -0
  365. nlr_gat-0.1.0/docs/source/python_api_load.md +701 -0
  366. nlr_gat-0.1.0/docs/source/scenario_quickstart.md +350 -0
  367. nlr_gat-0.1.0/docs/source/scenarios_and_simulations.md +380 -0
  368. nlr_gat-0.1.0/docs/source/sienna_scaling.md +103 -0
  369. nlr_gat-0.1.0/docs/source/simulation_interface_quick_reference.md +335 -0
  370. nlr_gat-0.1.0/docs/source/simulation_refactor_migration.md +565 -0
  371. nlr_gat-0.1.0/docs/source/testing_single_simulation_files.md +371 -0
  372. nlr_gat-0.1.0/examples/README.md +185 -0
  373. nlr_gat-0.1.0/examples/aggregate_datasets_example.py +310 -0
  374. nlr_gat-0.1.0/examples/dataset_base_power_example.py +341 -0
  375. nlr_gat-0.1.0/examples/explore_h5_structure.py +316 -0
  376. nlr_gat-0.1.0/examples/load_example.py +167 -0
  377. nlr_gat-0.1.0/examples/palette_generation_example.py +322 -0
  378. nlr_gat-0.1.0/examples/simulation_interface_example.py +372 -0
  379. nlr_gat-0.1.0/examples/test_simulation_discovery.py +259 -0
  380. nlr_gat-0.1.0/examples/test_simulation_file.py +237 -0
  381. nlr_gat-0.1.0/examples/test_yaml_dataset_configs.py +288 -0
  382. nlr_gat-0.1.0/examples/unified_dataset_config_example.py +432 -0
  383. nlr_gat-0.1.0/pyproject.toml +134 -0
  384. nlr_gat-0.1.0/setup.cfg +4 -0
  385. nlr_gat-0.1.0/src/gat/__init__.py +92 -0
  386. nlr_gat-0.1.0/src/gat/_version.py +24 -0
  387. nlr_gat-0.1.0/src/gat/backends/__init__.py +5 -0
  388. nlr_gat-0.1.0/src/gat/backends/duckdb_backend.py +883 -0
  389. nlr_gat-0.1.0/src/gat/categories.py +114 -0
  390. nlr_gat-0.1.0/src/gat/cli.py +243 -0
  391. nlr_gat-0.1.0/src/gat/cli_plot.py +196 -0
  392. nlr_gat-0.1.0/src/gat/cli_projects.py +440 -0
  393. nlr_gat-0.1.0/src/gat/cli_projects_v1.py +1798 -0
  394. nlr_gat-0.1.0/src/gat/cli_server.py +224 -0
  395. nlr_gat-0.1.0/src/gat/client/__init__.py +68 -0
  396. nlr_gat-0.1.0/src/gat/client/connection.py +62 -0
  397. nlr_gat-0.1.0/src/gat/client/remote_scenario.py +218 -0
  398. nlr_gat-0.1.0/src/gat/colors.py +205 -0
  399. nlr_gat-0.1.0/src/gat/config/__init__.py +60 -0
  400. nlr_gat-0.1.0/src/gat/core.py +26 -0
  401. nlr_gat-0.1.0/src/gat/datahelpers/__init__.py +6 -0
  402. nlr_gat-0.1.0/src/gat/datahelpers/base_system.py +368 -0
  403. nlr_gat-0.1.0/src/gat/datahelpers/geo/__init__.py +1 -0
  404. nlr_gat-0.1.0/src/gat/datahelpers/geo/bus_upload.py +455 -0
  405. nlr_gat-0.1.0/src/gat/datahelpers/geo/geo_helpers.py +76 -0
  406. nlr_gat-0.1.0/src/gat/datahelpers/h5Parsers.py +124 -0
  407. nlr_gat-0.1.0/src/gat/datahelpers/helpers.py +210 -0
  408. nlr_gat-0.1.0/src/gat/datahelpers/parsers.py +353 -0
  409. nlr_gat-0.1.0/src/gat/datahelpers/plexos_duckdb.py +245 -0
  410. nlr_gat-0.1.0/src/gat/datahelpers/sienna.py +683 -0
  411. nlr_gat-0.1.0/src/gat/datahelpers/sienna_system.py +577 -0
  412. nlr_gat-0.1.0/src/gat/datasets.py +65 -0
  413. nlr_gat-0.1.0/src/gat/interfaces.py +147 -0
  414. nlr_gat-0.1.0/src/gat/loader.py +474 -0
  415. nlr_gat-0.1.0/src/gat/logging_config.py +50 -0
  416. nlr_gat-0.1.0/src/gat/models/__init__.py +88 -0
  417. nlr_gat-0.1.0/src/gat/models/base.py +205 -0
  418. nlr_gat-0.1.0/src/gat/models/design.md +51 -0
  419. nlr_gat-0.1.0/src/gat/models/lookups.py +314 -0
  420. nlr_gat-0.1.0/src/gat/models/palette.py +331 -0
  421. nlr_gat-0.1.0/src/gat/models/project.py +572 -0
  422. nlr_gat-0.1.0/src/gat/models/reeds.py +5 -0
  423. nlr_gat-0.1.0/src/gat/models/scenario.py +388 -0
  424. nlr_gat-0.1.0/src/gat/models/sienna.py +210 -0
  425. nlr_gat-0.1.0/src/gat/models/simulation.py +50 -0
  426. nlr_gat-0.1.0/src/gat/models/system.py +279 -0
  427. nlr_gat-0.1.0/src/gat/models/user.py +424 -0
  428. nlr_gat-0.1.0/src/gat/models/utils.py +25 -0
  429. nlr_gat-0.1.0/src/gat/palette_generator.py +469 -0
  430. nlr_gat-0.1.0/src/gat/project_management/__init__.py +15 -0
  431. nlr_gat-0.1.0/src/gat/project_management/discovery.py +246 -0
  432. nlr_gat-0.1.0/src/gat/project_management/manager.py +556 -0
  433. nlr_gat-0.1.0/src/gat/quickplots/__init__.py +34 -0
  434. nlr_gat-0.1.0/src/gat/quickplots/backends/__init__.py +111 -0
  435. nlr_gat-0.1.0/src/gat/quickplots/backends/matplotlib_backend.py +244 -0
  436. nlr_gat-0.1.0/src/gat/quickplots/backends/plotly_backend.py +329 -0
  437. nlr_gat-0.1.0/src/gat/quickplots/backends/protocol.py +191 -0
  438. nlr_gat-0.1.0/src/gat/quickplots/config.py +75 -0
  439. nlr_gat-0.1.0/src/gat/quickplots/core.py +349 -0
  440. nlr_gat-0.1.0/src/gat/quickplots/dispatch.py +654 -0
  441. nlr_gat-0.1.0/src/gat/quickplots/generation_plots.py +230 -0
  442. nlr_gat-0.1.0/src/gat/quickplots/multi_system.py +115 -0
  443. nlr_gat-0.1.0/src/gat/quickplots/scenario_plotter.py +228 -0
  444. nlr_gat-0.1.0/src/gat/quickplots/system_plots.py +524 -0
  445. nlr_gat-0.1.0/src/gat/quickplots/transmission.py +213 -0
  446. nlr_gat-0.1.0/src/gat/quickplots/transmission_plots.py +137 -0
  447. nlr_gat-0.1.0/src/gat/quickplots/utils.py +299 -0
  448. nlr_gat-0.1.0/src/gat/registry/__init__.py +180 -0
  449. nlr_gat-0.1.0/src/gat/registry/utils.py +158 -0
  450. nlr_gat-0.1.0/src/gat/reports/README.md +41 -0
  451. nlr_gat-0.1.0/src/gat/reports/__init__.py +15 -0
  452. nlr_gat-0.1.0/src/gat/reports/figs_to_pptx.py +72 -0
  453. nlr_gat-0.1.0/src/gat/reports/scenario_single.py +372 -0
  454. nlr_gat-0.1.0/src/gat/reports/system_comparison.py +569 -0
  455. nlr_gat-0.1.0/src/gat/scenario.py +783 -0
  456. nlr_gat-0.1.0/src/gat/scenariohandlers/__init__.py +9 -0
  457. nlr_gat-0.1.0/src/gat/scenariohandlers/_deprecation.py +18 -0
  458. nlr_gat-0.1.0/src/gat/scenariohandlers/base.py +1101 -0
  459. nlr_gat-0.1.0/src/gat/scenariohandlers/compute.py +51 -0
  460. nlr_gat-0.1.0/src/gat/scenariohandlers/config_maps.py +182 -0
  461. nlr_gat-0.1.0/src/gat/scenariohandlers/egret.py +118 -0
  462. nlr_gat-0.1.0/src/gat/scenariohandlers/file_scenario.py +156 -0
  463. nlr_gat-0.1.0/src/gat/scenariohandlers/multi.py +282 -0
  464. nlr_gat-0.1.0/src/gat/scenariohandlers/plexos.py +539 -0
  465. nlr_gat-0.1.0/src/gat/scenariohandlers/reeds.py +400 -0
  466. nlr_gat-0.1.0/src/gat/scenariohandlers/sienna.py +908 -0
  467. nlr_gat-0.1.0/src/gat/scenarios/base.py +20 -0
  468. nlr_gat-0.1.0/src/gat/scenarios/plots/README.md +2 -0
  469. nlr_gat-0.1.0/src/gat/scenarios/utils.py +9 -0
  470. nlr_gat-0.1.0/src/gat/server/__init__.py +1 -0
  471. nlr_gat-0.1.0/src/gat/server/app.py +104 -0
  472. nlr_gat-0.1.0/src/gat/server/config.py +62 -0
  473. nlr_gat-0.1.0/src/gat/server/ingest.py +268 -0
  474. nlr_gat-0.1.0/src/gat/server/registry.py +263 -0
  475. nlr_gat-0.1.0/src/gat/server/routes.py +190 -0
  476. nlr_gat-0.1.0/src/gat/server/system_geo.py +169 -0
  477. nlr_gat-0.1.0/src/gat/simulations/__init__.py +77 -0
  478. nlr_gat-0.1.0/src/gat/simulations/base.py +527 -0
  479. nlr_gat-0.1.0/src/gat/simulations/generic_aggregator.py +472 -0
  480. nlr_gat-0.1.0/src/gat/simulations/plexos_duckdb.py +159 -0
  481. nlr_gat-0.1.0/src/gat/simulations/plexos_v1.py +108 -0
  482. nlr_gat-0.1.0/src/gat/simulations/sienna.py +972 -0
  483. nlr_gat-0.1.0/src/gat/simulations/sienna_v1.py +188 -0
  484. nlr_gat-0.1.0/src/gat/simulations/utils.py +213 -0
  485. nlr_gat-0.1.0/src/gat/systems/__init__.py +7 -0
  486. nlr_gat-0.1.0/src/gat/systems/base.py +15 -0
  487. nlr_gat-0.1.0/src/gat/systems/plexos.py +103 -0
  488. nlr_gat-0.1.0/src/gat/systems/plexos_duckdb.py +144 -0
  489. nlr_gat-0.1.0/src/gat/systems/sienna.py +581 -0
  490. nlr_gat-0.1.0/src/gat/systems/utils.py +3 -0
  491. nlr_gat-0.1.0/src/gat/utils.py +67 -0
  492. nlr_gat-0.1.0/src/nlr_gat.egg-info/PKG-INFO +196 -0
  493. nlr_gat-0.1.0/src/nlr_gat.egg-info/SOURCES.txt +561 -0
  494. nlr_gat-0.1.0/src/nlr_gat.egg-info/dependency_links.txt +1 -0
  495. nlr_gat-0.1.0/src/nlr_gat.egg-info/entry_points.txt +2 -0
  496. nlr_gat-0.1.0/src/nlr_gat.egg-info/requires.txt +56 -0
  497. nlr_gat-0.1.0/src/nlr_gat.egg-info/scm_file_list.json +556 -0
  498. nlr_gat-0.1.0/src/nlr_gat.egg-info/scm_version.json +8 -0
  499. nlr_gat-0.1.0/src/nlr_gat.egg-info/top_level.txt +1 -0
  500. nlr_gat-0.1.0/test_e2e_plot_pipeline.py +671 -0
  501. nlr_gat-0.1.0/test_path_resolution.py +382 -0
  502. nlr_gat-0.1.0/tests/__init__.py +2 -0
  503. nlr_gat-0.1.0/tests/conftest.py +235 -0
  504. nlr_gat-0.1.0/tests/datahelpers/__init__.py +0 -0
  505. nlr_gat-0.1.0/tests/datahelpers/test_agg_plexos_parallel.py +91 -0
  506. nlr_gat-0.1.0/tests/datahelpers/test_combine_frames.py +137 -0
  507. nlr_gat-0.1.0/tests/handlers/__init__.py +0 -0
  508. nlr_gat-0.1.0/tests/handlers/test_handlers.py +133 -0
  509. nlr_gat-0.1.0/tests/handlers/test_plexos_backend_detection.py +121 -0
  510. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_area_curtailment_aggregates_summary.csv +4 -0
  511. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_area_dispatch_user_reproducer_summary.csv +35 -0
  512. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_area_load_summary.csv +4 -0
  513. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_area_tech_aggregates_summary.csv +181 -0
  514. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_area_unserved_summary.csv +4 -0
  515. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_availability_summary.csv +156 -0
  516. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_availability_tech_summary.csv +156 -0
  517. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_curtailment_summary.csv +26 -0
  518. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_gen_and_curtailment_summary.csv +181 -0
  519. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_generation_capacity_full.csv +4 -0
  520. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_generation_summary.csv +156 -0
  521. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_generators_tech.csv +1561 -0
  522. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_line_congestion_hours_summary.csv +122 -0
  523. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_line_flow_summary.csv +122 -0
  524. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_line_loading_summary.csv +122 -0
  525. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_line_utilization_summary.csv +485 -0
  526. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_load_summary.csv +4 -0
  527. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_system_dispatch_summary.csv +16 -0
  528. nlr_gat-0.1.0/tests/handlers/test_plexos_regression/test_get_unserved_summary.csv +4 -0
  529. nlr_gat-0.1.0/tests/handlers/test_plexos_regression.py +185 -0
  530. nlr_gat-0.1.0/tests/handlers/test_plexos_scenario_dual_backend.py +115 -0
  531. nlr_gat-0.1.0/tests/handlers/test_plexos_v1_migration.py +89 -0
  532. nlr_gat-0.1.0/tests/handlers/test_public_config.py +67 -0
  533. nlr_gat-0.1.0/tests/handlers/test_sienna_multifile.py +146 -0
  534. nlr_gat-0.1.0/tests/handlers/test_sienna_regression/test_v4_get_area_dispatch_summary.csv +22 -0
  535. nlr_gat-0.1.0/tests/handlers/test_sienna_regression/test_v4_get_area_load_summary.csv +52 -0
  536. nlr_gat-0.1.0/tests/handlers/test_sienna_regression/test_v4_get_gen_and_curtailment_summary.csv +113 -0
  537. nlr_gat-0.1.0/tests/handlers/test_sienna_regression/test_v4_get_generators_tech.csv +169 -0
  538. nlr_gat-0.1.0/tests/handlers/test_sienna_regression.py +71 -0
  539. nlr_gat-0.1.0/tests/handlers/test_transmission.py +50 -0
  540. nlr_gat-0.1.0/tests/handlers/utils.py +37 -0
  541. nlr_gat-0.1.0/tests/models/__init__.py +0 -0
  542. nlr_gat-0.1.0/tests/models/test_data_models.py +164 -0
  543. nlr_gat-0.1.0/tests/models/test_scenario_default_palette.py +214 -0
  544. nlr_gat-0.1.0/tests/plots/test_plots.py +60 -0
  545. nlr_gat-0.1.0/tests/plots/utils.py +33 -0
  546. nlr_gat-0.1.0/tests/registry/test_registry.py +19 -0
  547. nlr_gat-0.1.0/tests/reports/__init__.py +0 -0
  548. nlr_gat-0.1.0/tests/reports/test_load_roundtrip.py +140 -0
  549. nlr_gat-0.1.0/tests/reports/test_scenario_single.py +123 -0
  550. nlr_gat-0.1.0/tests/simulations/__init__.py +0 -0
  551. nlr_gat-0.1.0/tests/simulations/test_combine_frames_aggregator.py +99 -0
  552. nlr_gat-0.1.0/tests/simulations/test_combine_overlapping_frames.py +77 -0
  553. nlr_gat-0.1.0/tests/simulations/test_dedup_slices.py +78 -0
  554. nlr_gat-0.1.0/tests/test_aggregate_datasets.py +297 -0
  555. nlr_gat-0.1.0/tests/test_duckdb_backend.py +496 -0
  556. nlr_gat-0.1.0/tests/test_loader.py +549 -0
  557. nlr_gat-0.1.0/tests/test_palette_generator.py +455 -0
  558. nlr_gat-0.1.0/tests/test_plexos_duckdb_backend.py +592 -0
  559. nlr_gat-0.1.0/tests/test_scenario_paths.py +317 -0
  560. nlr_gat-0.1.0/tests/test_sienna_v1.py +336 -0
  561. nlr_gat-0.1.0/tests/test_unified_dataset_yaml.py +300 -0
  562. nlr_gat-0.1.0/tests/visual/.gitignore +1 -0
  563. nlr_gat-0.1.0/tests/visual/generate_fixture_deck.py +172 -0
@@ -0,0 +1,69 @@
1
+ name: release
2
+
3
+ on:
4
+ push:
5
+ tags:
6
+ - 'v*'
7
+
8
+ jobs:
9
+ build:
10
+ runs-on: ubuntu-latest
11
+ permissions:
12
+ contents: write
13
+
14
+ steps:
15
+ - uses: actions/checkout@v4
16
+ with:
17
+ fetch-depth: 0
18
+
19
+ - name: Install uv
20
+ uses: astral-sh/setup-uv@v4
21
+
22
+ - name: Set up Python
23
+ uses: actions/setup-python@v5
24
+ with:
25
+ python-version: "3.12"
26
+
27
+ - name: Build sdist and wheel
28
+ run: uv build
29
+
30
+ - name: Upload release assets
31
+ uses: softprops/action-gh-release@v2
32
+ with:
33
+ files: |
34
+ dist/nlr_gat-*.whl
35
+ dist/nlr_gat-*.tar.gz
36
+
37
+ - name: Store dist for the publish job
38
+ uses: actions/upload-artifact@v4
39
+ with:
40
+ name: python-dist
41
+ path: dist/
42
+
43
+ # Publishes via PyPI Trusted Publishing (OIDC) — no API token is stored
44
+ # in the repo. One-time setup on PyPI is required before the first run:
45
+ # add a "pending publisher" for the project name `nlr-gat` with
46
+ # owner NatLabRockies, repository GridAnalysisToolkit, workflow
47
+ # release.yml, and environment pypi
48
+ # (https://pypi.org/manage/account/publishing/).
49
+ # The `pypi` GitHub environment is created automatically on first use;
50
+ # protection rules (required reviewers) can be added to it in repo
51
+ # Settings → Environments to gate publishes.
52
+ publish-pypi:
53
+ needs: build
54
+ runs-on: ubuntu-latest
55
+ environment:
56
+ name: pypi
57
+ url: https://pypi.org/p/nlr-gat
58
+ permissions:
59
+ id-token: write
60
+
61
+ steps:
62
+ - name: Download dist artifacts
63
+ uses: actions/download-artifact@v4
64
+ with:
65
+ name: python-dist
66
+ path: dist/
67
+
68
+ - name: Publish to PyPI
69
+ uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,159 @@
1
+ name: Sienna fixture refresh
2
+
3
+ # Deliberately (re)builds a Sienna fixture and refreshes its actions/cache
4
+ # entry under the *same* key scheme tests.yml's automatic "changes" /
5
+ # "sienna-fixture" / "pytest" jobs already use:
6
+ #
7
+ # sienna-<version>-${{ hashFiles('docker/sienna/Dockerfile', 'docker/sienna/*.toml', 'docker/sienna/generate.jl') }}
8
+ #
9
+ # Sienna's UC solve isn't perfectly reproducible run-to-run (MIP tie-breaking
10
+ # among equally-optimal dispatch solutions -- much improved by pinning solver
11
+ # behavior, but not guaranteed airtight forever across HDF5/solver version
12
+ # bumps). Letting the fixture cache regenerate *implicitly* -- e.g. on a
13
+ # 7-day cache eviction, a repo-wide cache-size eviction, or a race between
14
+ # two concurrent PR runs that both hit a cache miss at once -- means
15
+ # whichever build happens to "win" silently becomes the fixture every future
16
+ # run tests against, with no guarantee it matches the committed regression
17
+ # CSV baselines (tests/handlers/test_sienna_regression/*.csv). That mismatch
18
+ # is what caused CI failures on PR #8, unrelated to what that PR changed.
19
+ #
20
+ # This workflow turns fixture regeneration into a deliberate, reviewable,
21
+ # human-triggered act instead. Run it:
22
+ # - before merging a PR that touches docker/sienna/**, once you're happy
23
+ # with the fixture it produced
24
+ # - periodically as a safety refresh (e.g. if you suspect the cached
25
+ # fixture was silently evicted, or was built by a losing racer in a
26
+ # concurrent-PR cache-miss)
27
+ #
28
+ # IMPORTANT: after running this, the committed regression baselines will NOT
29
+ # match the newly-cached fixture until you regenerate and commit them -- see
30
+ # the job summary this workflow prints, or docker/sienna/README.md.
31
+
32
+ on:
33
+ workflow_dispatch:
34
+ inputs:
35
+ version:
36
+ description: >-
37
+ Sienna fixture version to refresh. Only v4 is wired into tests.yml
38
+ today; v5 (Manifest.v5.toml + `make sienna-fixture-v5` already
39
+ exist) is offered here so it can reuse this same workflow once
40
+ test_sienna_regression.py's v5 support and tests.yml's v5 wiring
41
+ land -- no redesign of this workflow needed then.
42
+ required: true
43
+ default: v4
44
+ type: choice
45
+ options:
46
+ - v4
47
+ - v5
48
+
49
+ permissions:
50
+ contents: read
51
+ actions: write # required for `gh cache delete`
52
+
53
+ jobs:
54
+ refresh:
55
+ runs-on: ubuntu-latest
56
+ env:
57
+ GH_TOKEN: ${{ github.token }}
58
+ steps:
59
+ - uses: actions/checkout@v4
60
+ with:
61
+ fetch-depth: 0
62
+
63
+ # GitHub Actions caches are scoped to the branch they're written from:
64
+ # visible to that branch, PRs based on it, and the default branch --
65
+ # but NOT to unrelated branches/PRs. workflow_dispatch lets you pick
66
+ # any ref to run from, so running this from a feature branch would
67
+ # silently populate a cache invisible to the PRs this workflow exists
68
+ # to protect. Restrict to main so a refresh is always globally visible.
69
+ - name: Require running from main
70
+ if: github.ref != 'refs/heads/main'
71
+ run: |
72
+ echo "::error::This workflow must be run from 'main' (got '${{ github.ref }}'). GitHub Actions cache entries are scoped to the branch they're written from, so refreshing from a feature branch would silently produce a cache invisible to unrelated PRs -- defeating the point. Switch the 'Use workflow from' branch selector to 'main' and re-run."
73
+ exit 1
74
+
75
+ - name: Resolve version number and cache key
76
+ id: vars
77
+ run: |
78
+ version="${{ inputs.version }}"
79
+ number="${version#v}"
80
+ key="sienna-${version}-${{ hashFiles('docker/sienna/Dockerfile', 'docker/sienna/*.toml', 'docker/sienna/generate.jl') }}"
81
+ {
82
+ echo "number=${number}"
83
+ echo "key=${key}"
84
+ echo "out_dir=example_data/sienna/${version}"
85
+ } >> "$GITHUB_OUTPUT"
86
+
87
+ # actions/cache does NOT overwrite an existing key -- a save to an
88
+ # already-populated key is silently skipped (with just a warning in
89
+ # the log). To force a genuinely fresh build+cache-write under the
90
+ # *same* key the automatic tests.yml jobs look up (so the very next PR
91
+ # run picks up the refresh automatically, no further changes needed),
92
+ # delete any existing entry for this key first. `gh cache delete`
93
+ # exits non-zero if no entry exists yet (e.g. first-ever build for
94
+ # this content hash) -- that's expected, not a failure of this job.
95
+ - name: Delete existing cache entry for this key (if any)
96
+ continue-on-error: true
97
+ run: gh cache delete "${{ steps.vars.outputs.key }}" --repo "${{ github.repository }}"
98
+
99
+ - name: Set up Docker Buildx
100
+ uses: docker/setup-buildx-action@v3
101
+
102
+ - name: Build sienna Docker image (with layer cache)
103
+ uses: docker/build-push-action@v6
104
+ with:
105
+ context: docker/sienna
106
+ build-args: SIENNA_VERSION=${{ steps.vars.outputs.number }}
107
+ tags: gat-sienna:${{ inputs.version }}
108
+ load: true
109
+ cache-from: type=gha,scope=sienna-docker-${{ inputs.version }}
110
+ cache-to: type=gha,mode=max,scope=sienna-docker-${{ inputs.version }}
111
+
112
+ - name: Generate sienna fixture data
113
+ run: |
114
+ mkdir -p "${{ steps.vars.outputs.out_dir }}"
115
+ docker run --rm \
116
+ -v "${{ github.workspace }}/${{ steps.vars.outputs.out_dir }}:/output" \
117
+ gat-sienna:${{ inputs.version }}
118
+
119
+ # Writes a fresh entry under the same key tests.yml's "changes" /
120
+ # "sienna-fixture" / "pytest" jobs already use -- since we deleted any
121
+ # prior entry above, the actions/cache action's implicit post-step
122
+ # save now has a clear key to write to instead of silently no-op'ing.
123
+ - name: Write refreshed fixture to actions/cache
124
+ uses: actions/cache@v4
125
+ with:
126
+ path: ${{ steps.vars.outputs.out_dir }}
127
+ key: ${{ steps.vars.outputs.key }}
128
+
129
+ - name: Upload refreshed fixture artifact
130
+ uses: actions/upload-artifact@v4
131
+ with:
132
+ name: sienna-${{ inputs.version }}-fixture-refreshed
133
+ path: ${{ steps.vars.outputs.out_dir }}/
134
+ retention-days: 7
135
+
136
+ - name: Print required follow-up
137
+ env:
138
+ FIXTURE_ENV_VAR: GAT_SIENNA_${{ inputs.version == 'v5' && 'V5' || 'V4' }}_FIXTURE
139
+ run: |
140
+ {
141
+ echo "## Sienna ${{ inputs.version }} fixture refreshed"
142
+ echo
143
+ echo "The \`actions/cache\` entry for key \`${{ steps.vars.outputs.key }}\` has been rebuilt and re-populated."
144
+ echo "The next automatic CI run (for any PR, as long as the fixture-relevant files (Dockerfile/Manifests/generate.jl) don't change again) will restore **this** fixture."
145
+ echo
146
+ echo "**This does NOT update the committed regression baselines.**"
147
+ echo "\`tests/handlers/test_sienna_regression.py\` snapshots (\`tests/handlers/test_sienna_regression/*.csv\`) still reflect the *previous* fixture until you regenerate and commit them:"
148
+ echo
149
+ echo "1. Download the \`sienna-${{ inputs.version }}-fixture-refreshed\` artifact from this workflow run."
150
+ echo "2. Extract it locally to \`example_data/sienna/${{ inputs.version }}\`."
151
+ echo "3. Run:"
152
+ echo ' ```bash'
153
+ echo " ${FIXTURE_ENV_VAR}=\$(pwd)/example_data/sienna/${{ inputs.version }} \\"
154
+ echo " pytest tests/handlers/test_sienna_regression.py --force-regen"
155
+ echo ' ```'
156
+ echo "4. Review the resulting CSV diffs and commit them, noting why the fixture was refreshed."
157
+ echo
158
+ echo "Skipping step 3-4 means CI's regression tests will start failing against the newly-cached fixture on the very next PR that restores it from cache."
159
+ } >> "$GITHUB_STEP_SUMMARY"
@@ -0,0 +1,99 @@
1
+ name: Sphinx build
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - main
7
+ tags:
8
+ - 'v*'
9
+
10
+ jobs:
11
+ # The example gallery (docs/gat_examples/*.py) executes scripts that
12
+ # construct a SiennaScenario from example_data/sienna/v4/{sys.json,
13
+ # simulation_store.h5} — sphinx-gallery runs them for real during the
14
+ # build. Mirrors the tests.yml `sienna-fixture` job (kept as a separate
15
+ # copy since GitHub Actions can't share a job definition across workflow
16
+ # files without a reusable-workflow refactor); see that file for the
17
+ # cache-first / build-on-miss rationale.
18
+ sienna-fixture:
19
+ runs-on: ubuntu-latest
20
+ steps:
21
+ - uses: actions/checkout@v4
22
+ with:
23
+ fetch-depth: 0
24
+
25
+ - name: Restore sienna v4 fixture cache
26
+ id: fixture-cache
27
+ uses: actions/cache@v4
28
+ with:
29
+ path: example_data/sienna/v4
30
+ key: sienna-v4-${{ hashFiles('docker/sienna/Dockerfile', 'docker/sienna/*.toml', 'docker/sienna/generate.jl') }}
31
+
32
+ - name: Set up Docker Buildx
33
+ if: steps.fixture-cache.outputs.cache-hit != 'true'
34
+ uses: docker/setup-buildx-action@v3
35
+
36
+ - name: Build sienna Docker image (with layer cache)
37
+ if: steps.fixture-cache.outputs.cache-hit != 'true'
38
+ uses: docker/build-push-action@v6
39
+ with:
40
+ context: docker/sienna
41
+ build-args: SIENNA_VERSION=4
42
+ tags: gat-sienna:v4
43
+ load: true
44
+ cache-from: type=gha,scope=sienna-docker-v4
45
+ cache-to: type=gha,mode=max,scope=sienna-docker-v4
46
+
47
+ - name: Generate sienna v4 fixture data
48
+ if: steps.fixture-cache.outputs.cache-hit != 'true'
49
+ run: |
50
+ mkdir -p example_data/sienna/v4
51
+ docker run --rm \
52
+ -v "${{ github.workspace }}/example_data/sienna/v4:/output" \
53
+ gat-sienna:v4
54
+
55
+ - name: Upload sienna v4 fixture artifact
56
+ uses: actions/upload-artifact@v4
57
+ with:
58
+ name: sienna-v4-fixture-docs
59
+ path: example_data/sienna/v4/
60
+ retention-days: 1
61
+
62
+ build:
63
+ needs: sienna-fixture
64
+ runs-on: ubuntu-latest
65
+ steps:
66
+ - uses: actions/checkout@v4
67
+ with:
68
+ fetch-depth: 0
69
+
70
+ - name: Set up Python
71
+ uses: actions/setup-python@v5
72
+ with:
73
+ python-version: "3.12"
74
+ cache: pip
75
+ cache-dependency-path: pyproject.toml
76
+
77
+ - name: Install dependencies
78
+ run: |
79
+ python -m pip install --upgrade pip
80
+ pip install -e ".[doc,reports]"
81
+
82
+ - name: Download sienna v4 fixture artifact
83
+ uses: actions/download-artifact@v4
84
+ with:
85
+ name: sienna-v4-fixture-docs
86
+ path: example_data/sienna/v4
87
+
88
+ - name: Build HTML
89
+ run: sphinx-build -b html docs/source docs/build/html
90
+
91
+ - name: Add .nojekyll file
92
+ run: touch docs/build/html/.nojekyll
93
+
94
+ - name: Deploy to GitHub Pages
95
+ if: github.ref == 'refs/heads/main' || github.ref_type == 'tag'
96
+ uses: peaceiris/actions-gh-pages@v3
97
+ with:
98
+ github_token: ${{ secrets.GITHUB_TOKEN }}
99
+ publish_dir: ./docs/build/html
@@ -0,0 +1,195 @@
1
+ name: tests
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+
8
+ jobs:
9
+ changes:
10
+ runs-on: ubuntu-latest
11
+ outputs:
12
+ sienna: ${{ steps.filter.outputs.sienna }}
13
+ steps:
14
+ - uses: actions/checkout@v4
15
+ with:
16
+ fetch-depth: 0
17
+
18
+ - name: Detect sienna-relevant changes
19
+ id: filter
20
+ uses: dorny/paths-filter@v3
21
+ with:
22
+ filters: |
23
+ sienna:
24
+ - 'docker/sienna/Dockerfile'
25
+ - 'docker/sienna/*.toml'
26
+ - 'docker/sienna/generate.jl'
27
+
28
+ # Fixture content is fully determined by the Dockerfile, Manifests,
29
+ # and generate.jl — deliberately NOT docker/sienna/** so that edits
30
+ # to docker/sienna/README.md don't invalidate the cache key. The
31
+ # filter above matches the cache key below; a lookup-only check
32
+ # tells us if a previous build is still available without paying
33
+ # for a download.
34
+ - name: Check for existing sienna v4 fixture cache
35
+ id: fixture-cache-check
36
+ uses: actions/cache/restore@v4
37
+ with:
38
+ path: example_data/sienna/v4
39
+ key: sienna-v4-${{ hashFiles('docker/sienna/Dockerfile', 'docker/sienna/*.toml', 'docker/sienna/generate.jl') }}
40
+ lookup-only: true
41
+
42
+ # Deliberately NOT an automatic rebuild-on-cache-miss fallback. Sienna's
43
+ # UC solve isn't bit-deterministic, so an implicit rebuild here (e.g.
44
+ # after the 7-day cache eviction, or a repo cache-size eviction, or two
45
+ # concurrent PR runs racing on the same cache-miss) would silently pick
46
+ # whichever build "wins" as the fixture every future run tests against,
47
+ # with no guarantee it matches the committed regression CSV baselines.
48
+ # That's exactly what caused the CI failures on PR #8. Fail fast and
49
+ # loudly instead, and point at the deliberate, human-triggered fix.
50
+ #
51
+ # Also fires on ANY push event with no cache hit, regardless of whether
52
+ # docker/sienna/** changed -- GitHub Actions caches are scoped per
53
+ # branch (a cache written on a feature branch is invisible to a
54
+ # separate push-triggered run on main), so sienna-fixture below no
55
+ # longer auto-rebuilds on push at all (see its own comment). Without
56
+ # this, merging a docker/sienna/**-touching PR would make main's own
57
+ # push-triggered run silently rebuild AGAIN on main's cache scope --
58
+ # an independent, equally-nondeterministic build that doesn't match
59
+ # whatever baselines the PR itself regenerated and merged. That's
60
+ # exactly what happened after PR #8 merged (see PR #9's history).
61
+ - name: Fail fast if the fixture cache is missing and nothing here will rebuild it
62
+ if: steps.fixture-cache-check.outputs.cache-hit != 'true' && (github.event_name != 'pull_request' || steps.filter.outputs.sienna != 'true')
63
+ run: |
64
+ echo "::error::No cached sienna v4 fixture found for key 'sienna-v4-${{ hashFiles('docker/sienna/Dockerfile', 'docker/sienna/*.toml', 'docker/sienna/generate.jl') }}', and nothing in this run will rebuild it (push events never auto-rebuild -- see the sienna-fixture job's condition -- and no fixture-relevant files (docker/sienna Dockerfile/Manifests/generate.jl) were changed in this PR). This is deliberate: an automatic rebuild-on-cache-miss fallback previously caused silent fixture drift (whichever concurrent build 'won' a cache-miss race became the fixture every future run tested against, with no guarantee it matched the committed regression baselines -- see PR #8/#9). Fix: have someone with write access run the 'Sienna fixture refresh' workflow (.github/workflows/sienna-fixture-refresh.yml) via workflow_dispatch to deliberately rebuild the fixture and refresh the cache, then regenerate + commit the regression baselines per its job summary / docker/sienna/README.md."
65
+ exit 1
66
+
67
+ sienna-fixture:
68
+ needs: changes
69
+ # Only pay for the Docker build pipeline on a pull_request that actually
70
+ # changed sienna-relevant files -- deliberate cache refreshes for
71
+ # cold-start/eviction cases go through the separate
72
+ # sienna-fixture-refresh.yml workflow (see the "changes" job's fail-fast
73
+ # step above).
74
+ #
75
+ # Deliberately excludes push events (i.e. merges to main), even when
76
+ # docker/sienna/** changed in that push: GitHub Actions cache scoping
77
+ # means a cache written here, on main's own push-triggered run, would be
78
+ # an entirely independent (and, given the solve's nondeterminism,
79
+ # near-certainly different) build from whatever the merged PR's own
80
+ # branch-scoped run already built and regenerated baselines against --
81
+ # not a "second confirmation," just fresh drift. Let it fail fast
82
+ # instead (see above) and require the same deliberate manual refresh
83
+ # every other cold-start case does.
84
+ if: needs.changes.outputs.sienna == 'true' && github.event_name == 'pull_request'
85
+ runs-on: ubuntu-latest
86
+ steps:
87
+ - uses: actions/checkout@v4
88
+ with:
89
+ fetch-depth: 0
90
+
91
+ - name: Restore sienna v4 fixture cache
92
+ id: fixture-cache
93
+ uses: actions/cache@v4
94
+ with:
95
+ path: example_data/sienna/v4
96
+ key: sienna-v4-${{ hashFiles('docker/sienna/Dockerfile', 'docker/sienna/*.toml', 'docker/sienna/generate.jl') }}
97
+
98
+ - name: Set up Docker Buildx
99
+ if: steps.fixture-cache.outputs.cache-hit != 'true'
100
+ uses: docker/setup-buildx-action@v3
101
+
102
+ - name: Build sienna Docker image (with layer cache)
103
+ if: steps.fixture-cache.outputs.cache-hit != 'true'
104
+ uses: docker/build-push-action@v6
105
+ with:
106
+ context: docker/sienna
107
+ build-args: SIENNA_VERSION=4
108
+ tags: gat-sienna:v4
109
+ load: true
110
+ cache-from: type=gha,scope=sienna-docker-v4
111
+ cache-to: type=gha,mode=max,scope=sienna-docker-v4
112
+
113
+ - name: Generate sienna v4 fixture data
114
+ if: steps.fixture-cache.outputs.cache-hit != 'true'
115
+ run: |
116
+ mkdir -p example_data/sienna/v4
117
+ docker run --rm \
118
+ -v "${{ github.workspace }}/example_data/sienna/v4:/output" \
119
+ gat-sienna:v4
120
+
121
+ - name: Upload sienna v4 fixture artifact
122
+ uses: actions/upload-artifact@v4
123
+ with:
124
+ name: sienna-v4-fixture
125
+ path: example_data/sienna/v4/
126
+ retention-days: 7
127
+
128
+ pytest:
129
+ needs: [changes, sienna-fixture]
130
+ # sienna-fixture is intentionally skipped when nothing sienna-relevant
131
+ # changed and a cached fixture already exists — that's not a failure.
132
+ # Require changes to have actually succeeded too: if its fail-fast step
133
+ # tripped (no cache and no rebuild queued), sienna-fixture is skipped as
134
+ # a normal consequence of its failed dependency, which would otherwise
135
+ # let this job slip through the `always()` and fail later/more expensively
136
+ # (mid-matrix, on the cache restore's fail-on-cache-miss) instead of fast.
137
+ if: always() && needs.changes.result == 'success' && (needs.sienna-fixture.result == 'success' || needs.sienna-fixture.result == 'skipped')
138
+ runs-on: ubuntu-latest
139
+ strategy:
140
+ fail-fast: false
141
+ matrix:
142
+ python-version: ["3.10", "3.12"]
143
+
144
+ steps:
145
+ - uses: actions/checkout@v4
146
+ with:
147
+ fetch-depth: 0
148
+
149
+ - name: Set up Python ${{ matrix.python-version }}
150
+ uses: actions/setup-python@v5
151
+ with:
152
+ python-version: ${{ matrix.python-version }}
153
+ cache: pip
154
+
155
+ - name: Install
156
+ run: |
157
+ python -m pip install --upgrade pip
158
+ pip install -e ".[dev,reports]"
159
+
160
+ - name: Download sienna v4 fixture artifact
161
+ if: needs.sienna-fixture.result == 'success'
162
+ uses: actions/download-artifact@v4
163
+ with:
164
+ name: sienna-v4-fixture
165
+ path: example_data/sienna/v4
166
+
167
+ - name: Restore sienna v4 fixture from cache
168
+ if: needs.sienna-fixture.result == 'skipped'
169
+ uses: actions/cache/restore@v4
170
+ with:
171
+ path: example_data/sienna/v4
172
+ key: sienna-v4-${{ hashFiles('docker/sienna/Dockerfile', 'docker/sienna/*.toml', 'docker/sienna/generate.jl') }}
173
+ fail-on-cache-miss: true
174
+
175
+ # Sienna's UC solve isn't bit-deterministic run-to-run (MIP tie-
176
+ # breaking among equally-optimal dispatch solutions), so a fresh
177
+ # local `make sienna-fixture-v4` won't reproduce the exact fixture
178
+ # CI is testing against. Uploading it here (whichever path produced
179
+ # it) makes the exact bytes CI used downloadable for regenerating
180
+ # regression snapshot baselines locally — only from Python 3.10 to
181
+ # avoid a redundant duplicate upload from the matrix's other leg.
182
+ - name: Upload sienna v4 fixture actually used by this run
183
+ if: matrix.python-version == '3.10'
184
+ uses: actions/upload-artifact@v4
185
+ with:
186
+ name: sienna-v4-fixture-used
187
+ path: example_data/sienna/v4/
188
+ retention-days: 7
189
+
190
+ - name: Run pytest
191
+ env:
192
+ GAT_PLEXOS_FIXTURE: ${{ github.workspace }}/example_data/plexos
193
+ GAT_SIENNA_V4_FIXTURE: ${{ github.workspace }}/example_data/sienna/v4
194
+ GAT_SIENNA_V5_FIXTURE: ${{ github.workspace }}/example_data/sienna/v5
195
+ run: pytest tests/ -v
@@ -0,0 +1,173 @@
1
+ # macOS Finder metadata
2
+ .DS_Store
3
+
4
+ # Byte-compiled / optimized / DLL files
5
+ __pycache__/
6
+ *.py[cod]
7
+ *$py.class
8
+
9
+ # C extensions
10
+ *.so
11
+
12
+ # Distribution / packaging
13
+ .Python
14
+ build/
15
+ develop-eggs/
16
+ dist/
17
+ downloads/
18
+ eggs/
19
+ .eggs/
20
+ lib/
21
+ lib64/
22
+ parts/
23
+ sdist/
24
+ var/
25
+ wheels/
26
+ pip-wheel-metadata/
27
+ share/python-wheels/
28
+ *.egg-info/
29
+ .installed.cfg
30
+ *.egg
31
+ MANIFEST
32
+
33
+ # PyInstaller
34
+ # Usually these files are written by a python script from a template
35
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
36
+ *.manifest
37
+ *.spec
38
+
39
+ # Installer logs
40
+ pip-log.txt
41
+ pip-delete-this-directory.txt
42
+
43
+ # Unit test / coverage reports
44
+ htmlcov/
45
+ .tox/
46
+ .nox/
47
+ .coverage
48
+ .coverage.*
49
+ .cache
50
+ nosetests.xml
51
+ coverage.xml
52
+ *.cover
53
+ *.py,cover
54
+ .hypothesis/
55
+ .pytest_cache/
56
+
57
+ # Translations
58
+ *.mo
59
+ *.pot
60
+
61
+ # Django stuff:
62
+ *.log
63
+ local_settings.py
64
+ db.sqlite3
65
+ db.sqlite3-journal
66
+
67
+ # Flask stuff:
68
+ instance/
69
+ .webassets-cache
70
+
71
+ # Scrapy stuff:
72
+ .scrapy
73
+
74
+ # Sphinx documentation
75
+ #docs/_build/
76
+ !docs/build/
77
+
78
+ # PyBuilder
79
+ target/
80
+
81
+ # Jupyter Notebook
82
+ .ipynb_checkpoints
83
+
84
+ # IPython
85
+ profile_default/
86
+ ipython_config.py
87
+
88
+ # pyenv
89
+ .python-version
90
+
91
+ # pipenv
92
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
94
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
95
+ # install all needed dependencies.
96
+ #Pipfile.lock
97
+
98
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow
99
+ __pypackages__/
100
+
101
+ # Celery stuff
102
+ celerybeat-schedule
103
+ celerybeat.pid
104
+
105
+ # SageMath parsed files
106
+ *.sage.py
107
+
108
+ # Environments
109
+ .env
110
+ .venv
111
+ env/
112
+ venv/
113
+ ENV/
114
+ env.bak/
115
+ venv.bak/
116
+ uv.lock
117
+
118
+ # Spyder project settings
119
+ .spyderproject
120
+ .spyproject
121
+
122
+ # Rope project settings
123
+ .ropeproject
124
+
125
+ # mkdocs documentation
126
+ /site
127
+
128
+ # mypy
129
+ .mypy_cache/
130
+ .dmypy.json
131
+ dmypy.json
132
+
133
+ # Pyre type checker
134
+ .pyre/
135
+
136
+ #notebooks
137
+ *.ipynb
138
+
139
+ # yaml files
140
+ *.yaml
141
+
142
+ # reporting files
143
+ *.pptx
144
+ *.png
145
+ *.csv
146
+
147
+ # ...except pytest-regressions snapshot baselines, which must be tracked —
148
+ # this blanket *.csv rule was silently preventing them from ever being
149
+ # committed, so every fresh checkout failed with "File not found in data
150
+ # directory, created: ..." instead of comparing against a real baseline.
151
+ !tests/handlers/test_sienna_regression/*.csv
152
+ !tests/handlers/test_sienna_multifile/*.csv
153
+ !tests/handlers/test_plexos_regression/*.csv
154
+
155
+ # ...and source diagrams, which are documentation assets rather than
156
+ # generated report output. docs/source/index.md renders these directly,
157
+ # so the blanket *.png rule above would silently break the docs build.
158
+ !docs/source/diagrams/*.png
159
+
160
+ # version file
161
+ src/gat/_version.py
162
+
163
+ # Example data — too large to track. Regenerate Sienna fixtures via
164
+ # `make sienna-fixture-v4`; bring your own Plexos h5 files and set
165
+ # GAT_PLEXOS_FIXTURE to point at them.
166
+ example_data/
167
+
168
+ # Sphinx build artifacts (generated; not tracked)
169
+ docs/build/
170
+ docs/source/gat_plot_examples/
171
+ docs/source/sg_execution_times.rst
172
+ # Scratch data — too large to track. See docs/source/sienna_scaling.md
173
+ data/