348 documentation for assets in simulator core#354
Merged
MichielTukker merged 66 commits intoJun 25, 2026
Conversation
Future: remove automatically generated documentation parts unused.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Modifications to already existing documentation to remove warnings. Initial commit documentation Initial commit of documentation Future: remove automatically generated documentation parts unused. Links between doc Intermediate update
…s://github.com/Project-OMOTES/simulator-core into 348-documentation-for-assets-in-simulator_core
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Modifications to already existing documentation to remove warnings. Initial commit documentation Initial commit of documentation Future: remove automatically generated documentation parts unused. Links between doc Intermediate update
Future: remove automatically generated documentation parts unused.
…s://github.com/Project-OMOTES/simulator-core into 348-documentation-for-assets-in-simulator_core
Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Modifications to already existing documentation to remove warnings. Initial commit documentation Initial commit of documentation Future: remove automatically generated documentation parts unused. Links between doc Intermediate update Modifications to already existing documentation to remove warnings. Initial commit documentation Initial commit of documentation Future: remove automatically generated documentation parts unused. Links between doc Intermediate update
Future: remove automatically generated documentation parts unused.
…s://github.com/Project-OMOTES/simulator-core into 348-documentation-for-assets-in-simulator_core
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Added getting of temepratures from esdl for heat pump Also fixed heat exchanger and fixed test and test cases Added addtional test for new method Fixed formatting Fixes based on copilot sugestion Changed temepratues into data object Moved temeprature conversion routines and used them in the mapper Fixed lnting errors removed duplicate file Adjusted other assets to also use the Temperatures data class with in and out low temperature Fixed test case and small linting and formatting error Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Modifications to already existing documentation to remove warnings. Initial commit documentation Initial commit of documentation Future: remove automatically generated documentation parts unused. Links between doc Intermediate update Modifications to already existing documentation to remove warnings. Initial commit documentation Initial commit of documentation Future: remove automatically generated documentation parts unused. Links between doc Intermediate update Modifications to already existing documentation to remove warnings. Initial commit documentation Initial commit of documentation Future: remove automatically generated documentation parts unused. Links between doc Intermediate update
Future: remove automatically generated documentation parts unused.
Future: remove automatically generated documentation parts unused.
Future: remove automatically generated documentation parts unused.
…s://github.com/Project-OMOTES/simulator-core into 348-documentation-for-assets-in-simulator_core # Conflicts: # doc/physics/heat_exchanger_physics.rst # doc/physics/producer_physics.rst
MichielTukker
requested review from
MichielTukker and
Copilot
and removed request for
samvanderzwan
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures and expands the project’s Sphinx documentation set (new conceptual pages, curated reference landing pages, generated API docs wiring), plus a handful of docstring/formatting cleanups in Python source.
Changes:
- Adds new Intro / Solver / Network / Physics / Developer Documentation / Support pages and reshapes toctrees to match the new doc taxonomy.
- Adds a Sphinx
conf.pyhook to generate API docs viasphinx.ext.apidocand normalizes generated titles. - Performs small docstring and formatting updates across solver/network/controller code.
Reviewed changes
Copilot reviewed 196 out of 198 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| src/omotes_simulator_core/solver/utils/fluidprop.py | Docstring formatting tweak for lambda_ property. |
| src/omotes_simulator_core/solver/network/assets/solver_pipe.py | Docstring spacing tweak. |
| src/omotes_simulator_core/solver/network/assets/production_asset.py | Docstring cleanup/parameter docs. |
| src/omotes_simulator_core/solver/network/assets/node.py | Docstring parameter docs cleanup. |
| src/omotes_simulator_core/solver/network/assets/boundary.py | Docstring spacing tweak. |
| src/omotes_simulator_core/solver/network/assets/base_item.py | Docstring typo fix/formatting. |
| src/omotes_simulator_core/entities/utility/influxdb_reader.py | Quote-stripping and formatting cleanup. |
| src/omotes_simulator_core/entities/network_controller.py | Docstring wording/formatting updates. |
| src/omotes_simulator_core/entities/assets/production_cluster.py | Docstring inequality formatting update. |
| src/omotes_simulator_core/entities/assets/controller/controller_network.py | Docstring indentation fix. |
| src/omotes_simulator_core/entities/assets/asset_defaults.py | Docstring indentation/spacing fixes. |
| src/omotes_simulator_core/adapter/transforms/mappers.py | Docstring indentation fix. |
| src/omotes_simulator_core/adapter/transforms/controller_mappers/controller_heat_transfer_mapper.py | Adds blank line after module docstring. |
| doc/support/support.rst | New support landing page. |
| doc/solver/solver.rst | Adds :no-index: to autodoc page. |
| doc/solver/solver_workflow.rst | New conceptual solver workflow page. |
| doc/solver/solver_utility.rst | Adds :no-index: to autodoc page. |
| doc/solver/solver_unknowns_and_equations.rst | New conceptual unknowns/equations page. |
| doc/solver/solver_main.rst | New solver landing page structure/toctree. |
| doc/solver/solver_convergence.rst | New conceptual solver convergence page. |
| doc/solver/network.rst | Adds :no-index: to autodoc page. |
| doc/solver/matrix.rst | Formatting + adds :no-index:. |
| doc/solver/equation_object.rst | Adds :no-index: to autodoc page. |
| doc/solver/assets/solver_production_asset.rst | New solver asset reference stub. |
| doc/solver/assets/solver_pipe.rst | Adds :no-index:. |
| doc/solver/assets/solver_node.rst | Adds :no-index: entries. |
| doc/solver/assets/solver_heatboundary.rst | Adds :no-index:. |
| doc/solver/assets/solver_heat_transfer_asset.rst | New solver asset reference stub. |
| doc/solver/assets/solver_buffer_asset.rst | New solver asset reference stub. |
| doc/solver/assets/solver_boundary.rst | New solver asset module reference stub. |
| doc/solver/assets/solver_air_to_water_heat_pump_asset.rst | New solver asset reference stub. |
| doc/solver/assets/base_node_item.rst | New solver base-class reference stub. |
| doc/solver/assets/base_item.rst | Adds :no-index:. |
| doc/solver/assets/base_asset.rst | Adds :no-index:. |
| doc/solver/asset_main.rst | Updates solver asset toctree entries. |
| doc/run_spinx.bat | Improves Windows Sphinx build bootstrap script. |
| doc/reference/solver_uncovered_entities.rst | New “supporting entities” landing page. |
| doc/reference/solver_reference.rst | New curated solver reference landing page. |
| doc/reference/controller_uncovered_entities.rst | New “supporting entities” landing page. |
| doc/reference/controller_reference.rst | New curated controller reference landing page. |
| doc/reference/asset_uncovered_entities.rst | New “supporting entities” landing page. |
| doc/reference/asset_reference.rst | New curated asset reference landing page. |
| doc/reference/architecture_reference.rst | New curated architecture reference landing page. |
| doc/physics/producer_physics.rst | New producer physics page. |
| doc/physics/pipe_physics.rst | New pipe physics page. |
| doc/physics/physics_main.rst | New physics landing page/toctree. |
| doc/physics/junction_physics.rst | New junction physics page. |
| doc/physics/ideal_heat_storage_physics.rst | New storage physics page. |
| doc/physics/heat_pump_physics.rst | New heat pump physics page. |
| doc/physics/heat_exchanger_physics.rst | New heat exchanger physics page. |
| doc/physics/consumer_physics.rst | New consumer physics page. |
| doc/physics/ates_cluster_physics.rst | New ATES physics page. |
| doc/physics/air_to_water_heat_pump_physics.rst | New air-to-water heat pump physics page. |
| doc/network/network_main.rst | New network landing page. |
| doc/intro/simulation_input_and_output.rst | New intro page. |
| doc/intro/package_scope.rst | New intro page. |
| doc/intro/intro_main.rst | New intro landing page/toctree. |
| doc/intro/audience_and_use_cases.rst | New intro page. |
| doc/index.rst | Updates top-level doc navigation and section order. |
| doc/developer/developer_navigation.rst | New developer navigation page. |
| doc/developer/developer_main.rst | New developer docs landing page/toctree. |
| doc/developer/api/omotes_simulator_core.rst | Generated API root index. |
| doc/developer/api/omotes_simulator_core.adapter.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.presentation.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_consumer_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_heat_transfer_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_producer_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_storage_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.ates_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.consumer_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.heat_exchanger_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.heat_pump_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.ideal_heat_storage_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.pipe_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.producer_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_graph_mapper.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.mappers.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.string_to_esdl.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.transforms.transform_utils.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.utility.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.adapter.utility.graph.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.air_to_water_heat_pump.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.asset_abstract.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.asset_defaults.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.ates_cluster.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.demand_cluster.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.esdl_asset_object.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.heat_exchanger.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.heat_pump.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.ideal_heat_storage.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.junction.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.pipe.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.production_cluster.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.pyjnius_loader.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.utils.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.controller.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.controller.asset_controller_abstract.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_consumer.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_heat_transfer.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_network.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_producer.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_storage.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.controller.profile_interpolation.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.assets.controller.temperature_data.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.esdl_object.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.heat_network.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.network_controller.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.network_controller_abstract.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.simulation_configuration.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.utility.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.entities.utility.influxdb_reader.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.infrastructure.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.infrastructure.app.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.infrastructure.plotting.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.infrastructure.profiling.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.infrastructure.simulation_manager.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.infrastructure.utils.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.simulation.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.simulation.mappers.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.simulation.mappers.mappers.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.simulation.networksimulation.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.solver.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.solver_constants.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.matrix.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.matrix.equation_object.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.matrix.index_core_quantity.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.matrix.matrix.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.network.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.assets.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.assets.air_to_water_heat_pump.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.assets.base_asset.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.assets.base_item.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.assets.base_node_item.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.assets.boundary.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.assets.buffer_asset.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.assets.fall_type.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.assets.heat_transfer_asset.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.assets.node.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.assets.production_asset.rst | Generated API stub. |
| doc/developer/api/omotes_simulator_core.solver.network.assets.solver_pipe.rst | Generated API stub. |
| doc/controller/sub_network_class.rst | Updates controller class reference text. |
| doc/controller/main_controller_class.rst | Updates controller class reference text. |
| doc/controller/controller.rst | Rewrites controller overview and toctree. |
| doc/controller/assets/profile_interpolation.rst | New controller doc stub. |
| doc/controller/assets/producer.rst | Updates controller producer reference text. |
| doc/controller/assets/controller_storage.rst | New controller storage doc stub. |
| doc/controller/assets/controller_network.rst | New controller network doc stub. |
| doc/controller/assets/controller_heat_transfer.rst | New controller heat transfer doc stub. |
| doc/controller/assets/consumer.rst | Updates controller consumer reference text. |
| doc/controller/assets/ates.rst | Updates controller ATES reference text. |
| doc/controller/assets/asset_controller_abstract.rst | New controller abstract doc stub. |
| doc/conf.py | Adds apidoc generation hook + title normalization. |
| doc/assets/*.rst | Adds/updates entity-level asset reference pages (some currently orphaned). |
| doc/architecture/architecture.rst | Adjusts architecture landing-page links. |
| doc/assets/assets.rst | Removes legacy assets landing page. |
| .vscode/settings.json | Adds terminal auto-approve settings (needs removal). |
| .github/instructions/documentation-architecture.instructions.md | Adds documentation architecture conventions. |
| .github/agents/*.agent.md | Adds doc-agent definitions/guidance files. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
MichielTukker
requested changes
Jun 25, 2026
Removed python.exe and '&' from settings.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
orphaned page, not useful for documentation
orphaned page, not useful for documentation
orphaned page, not useful for documentation
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
orphaned page, not useful for documentation
orphaned page, not useful for documentation
MichielTukker
approved these changes
Jun 25, 2026
MichielTukker
left a comment
MichielTukker
left a comment
Contributor
There was a problem hiding this comment.
Approved with fixes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.