diff --git a/.github/agents/ControllerBehaviorDocAgent.agent.md b/.github/agents/ControllerBehaviorDocAgent.agent.md index 0cdfe768..87cb262a 100644 --- a/.github/agents/ControllerBehaviorDocAgent.agent.md +++ b/.github/agents/ControllerBehaviorDocAgent.agent.md @@ -97,6 +97,11 @@ existing ``doc/controller/behavior`` page as the structural template. setpoints, and physical-impact claims. Anchor the network dispatch description in ``NetworkController.update_setpoints``. +3. For updates scoped to ``doc/controller/controller_behavior.rst``, also consult: + ``doc/physics/ideal_heat_storage_physics.rst`` for fill-level and effective + charge/discharge-capability interpretation, and ``doc/physics/heat_pump_physics.rst`` for + water-to-water heat-pump terminology context. + Rules for source usage: - Use repository sources only. - Ground every decision-logic and physical-impact claim in the actual implementation, not in @@ -192,6 +197,12 @@ curtail consumers), plus heat-transfer conversion and the pressure-set asset sel For a component page, cover that component's local rule (for example deriving effective storage charge/discharge power from available volume, or applying a producer priority and factor). +For the ``Dispatch Logic for Supply, Demand, and Storage`` section in +``doc/controller/controller_behavior.rst``, explicitly explain how storage fill level affects +effective charge and discharge capability, including why capability clips near empty/full bounds, +and cross-link to ``doc/physics/ideal_heat_storage_physics.rst`` instead of re-deriving +asset-internal physics. + Give the governing relation in simplified engineering form where it clarifies the decision. Setpoints Produced @@ -274,6 +285,9 @@ the shared style rules. In addition: - Prefer short paragraphs with direct interpretation of decisions and their consequences. - Avoid textbook density and implementation-oriented wording. - Avoid unnecessary bullets outside tables, assumptions, and limitations. +- For ``doc/controller/controller_behavior.rst`` specifically, use + ``water-to-water heat-pump`` as the preferred term in place of + ``four-port heat pump`` or ``four-port heat-pump``. reStructuredText requirements ----------------------------- @@ -305,13 +319,16 @@ After writing or updating a behavior page: existing ``doc/controller`` pages. 5. Verify that decision-logic and physical-impact claims are supported by the source files in the source-priority table. -6. Verify the page is toctreed only from ``doc/controller/controller.rst`` and not duplicated in +6. For ``doc/controller/controller_behavior.rst``, verify terminology uses + ``water-to-water heat-pump`` and that storage-dispatch explanations include fill-level impact + and clipping context with a physics cross-link. +7. Verify the page is toctreed only from ``doc/controller/controller.rst`` and not duplicated in any ``doc/reference/`` page. -7. If command execution or validation tools are available, run ``doc/run_spinx.bat`` or the +8. If command execution or validation tools are available, run ``doc/run_spinx.bat`` or the repository-preferred documentation build command. -8. Inspect the build output for warnings and errors related to the new or edited page, +9. Inspect the build output for warnings and errors related to the new or edited page, including rst syntax errors, malformed tables, invalid math blocks, broken references, and broken toctrees. -9. If an error or warning is found, fix it before returning the final content. -10. Do not finish with known syntax errors, broken section structure, malformed tables, broken +10. If an error or warning is found, fix it before returning the final content. +11. Do not finish with known syntax errors, broken section structure, malformed tables, broken math blocks, or unresolved build warnings caused by the change. diff --git a/.github/agents/DocReviewAgent.agent.md b/.github/agents/DocReviewAgent.agent.md index 6bc08eb0..4fa748ae 100644 --- a/.github/agents/DocReviewAgent.agent.md +++ b/.github/agents/DocReviewAgent.agent.md @@ -183,6 +183,14 @@ Flag the following as errors: - contributor control guides drifting into end-user explanation as their primary purpose, - controller API reference pages containing long narrative explanation better suited for conceptual docs or developer guides. +For reviews of ``doc/controller/controller_behavior.rst``, also flag as errors: +- use of ``four-port heat pump`` or ``four-port heat-pump`` where + ``water-to-water heat-pump`` terminology is required, +- missing explanation in ``Dispatch Logic for Supply, Demand, and Storage`` of how fill level + constrains effective storage charge/discharge capability and clipping near empty/full bounds, +- missing cross-link to ``doc/physics/ideal_heat_storage_physics.rst`` when storage fill-level + interpretation is discussed. + Completeness review by page type -------------------------------- Review each page according to its type. @@ -270,6 +278,11 @@ Before accepting a page, verify that: - it links to the right neighboring documentation where useful, - it does not blur the boundary between conceptual docs, physics docs, developer guides, API reference, navigation, and support. +For ``doc/controller/controller_behavior.rst`` specifically, also verify: +- terminology uses ``water-to-water heat-pump`` consistently, +- storage dispatch explanation includes fill-level impact and clipping behavior, +- storage fill-level interpretation links to ``doc/physics/ideal_heat_storage_physics.rst``. + Validation ---------- After review and any focused edits: diff --git a/.github/agents/DocumentationCoordinator.agent.md b/.github/agents/DocumentationCoordinator.agent.md index f0a82aaa..d953bf8b 100644 --- a/.github/agents/DocumentationCoordinator.agent.md +++ b/.github/agents/DocumentationCoordinator.agent.md @@ -217,6 +217,9 @@ If a control-related request is ambiguous, classify by the primary question bein When a request mixes more than one of these, split it into multiple sub-tasks and assign them separately. Do not allow a single page to serve all three purposes. +If the user explicitly scopes a request to ``doc/controller/controller_behavior.rst`` only, +keep scope locked to that single page unless the user asks to broaden scope. + Audience separation rules ------------------------- Enforce the following audience boundaries: @@ -296,6 +299,14 @@ When delegating to a specialist agent, always specify: - validation criteria, - required cross-links to adjacent sections where relevant. +For tasks scoped to ``doc/controller/controller_behavior.rst``, also specify: +- terminology requirement: use ``water-to-water heat-pump`` wording, +- completeness requirement: in the ``Dispatch Logic for Supply, Demand, and Storage`` section, + explain storage fill-level impact on effective charge/discharge capability and clipping near + empty/full bounds, +- physics link requirement: include a cross-link to + ``doc/physics/ideal_heat_storage_physics.rst`` for asset-internal storage behavior. + The coordinator must not delegate vague requests such as: - "write the docs" - "improve this page" @@ -324,6 +335,9 @@ Each delegated task must include: - validation criteria, - required cross-links where relevant. +For control-behavior tasks scoped to ``doc/controller/controller_behavior.rst``, add explicit +exclusions preventing edits to other pages unless the user requests broader scope. + Coordinator output format ------------------------- For each request, produce a coordination plan containing: diff --git a/.github/agents/SystemConceptDocAgent.agent.md b/.github/agents/SystemConceptDocAgent.agent.md index 994242a4..06e70c12 100644 --- a/.github/agents/SystemConceptDocAgent.agent.md +++ b/.github/agents/SystemConceptDocAgent.agent.md @@ -77,6 +77,7 @@ Before writing, inspect the closest matching existing documentation page and pre - For Solver pages: ``doc/solver/solver_main.rst`` - For Network pages: ``doc/network/network_main.rst`` - For Control pages: ``doc/controller/controller.rst`` + - For Control behavioral terminology/context only: ``doc/controller/controller_behavior.rst`` - ``doc/physics/physics_main.rst`` (cross-reference landing page only, not a style source for Physics content itself) - ``doc/architecture/architecture.rst`` - any existing landing page in the same section as ```` @@ -146,7 +147,10 @@ Classify the page intent as follows: how the network is represented conceptually, how assets and connectivity affect behavior, and how users should think about network-level interactions - ``Control``: - current control concepts, setpoint propagation, operating logic at a conceptual level, and the user-visible consequences of control actions + current control concepts, setpoint propagation, operating logic at a conceptual level, and the user-visible consequences of control actions. + Keep descriptions tied to the heat-network physics interface: controller output should be framed as + requested heat extraction/injection and boundary-condition intent that is later realized or constrained + by the hydraulic and thermal solve. Do not use this agent to document: - how to extend control classes as a contributor, @@ -205,6 +209,8 @@ Optional sections: Optional sections may be added only when they materially improve clarity. +**For ``Control`` pages specifically:** Omit the ``Limitations`` section. Control pages should end with ``Assumptions`` before proceeding to ``Related Documentation`` or the toctree. + Section requirements -------------------- @@ -215,6 +221,10 @@ Explain: - why it matters, - how readers should think about it. +For ``Control`` pages, phrase overview text in terms of physics-facing setpoint intent (for example, +asset-level heat extraction/injection requests and pressure-boundary intent for the timestep solve), +not only generic demand-profile propagation wording. + For ``Intro`` pages, explicitly include: - what OMOTES.SIMULATOR_CORE does, - why it is used in practice. @@ -244,6 +254,37 @@ Examples: Keep definitions concise and simulation-oriented. +For ``Control`` pages, format each concept as a reStructuredText definition list: + + **Concept Name** + Definition text here. For multi-line definitions, continue text on the next line with consistent indentation (same indent level as the first line of the definition). + +**IMPORTANT for reStructuredText formatting:** To prevent text from being boxed as literal blocks: + - Do NOT use extra indentation or line breaks that create gaps in the definition text. + - Do NOT use ``::`` or ``|`` markers within definitions. + - Write multi-line definitions as flowing text with uniform indentation, not as separate paragraphs or code blocks. + - Example of CORRECT formatting: + + **Storages** + Flexible control components that can absorb or release heat. In the current model this includes ideal heat storage and ATES-based storage. Effective charge and discharge capability depends on current fill level or state of charge, which affects how much storage can contribute in a timestep. + + - Example of INCORRECT formatting (will create a box): + + **Storages** + Flexible control components that can absorb or release heat. In the current model this includes + ideal heat storage and ATES-based storage. Effective charge and discharge capability depends on + current fill level or state of charge, which affects how much storage can contribute in a timestep. + +Include at least these concepts when relevant to the current model: +- Network Controller: the top-level control component that coordinates subnetworks +- Subnetworks: hydraulically separated groups of assets +- Consumers: demand-side components +- Producers: supply-side components +- Storages: flexible components with effective charge/discharge capability tied to fill level or state of charge +- Heat-transfer assets: coupling components between subnetworks +- Setpoints: asset-level control targets +- Priority: dispatch ordering used when producer output must be capped; determines which producer supplies heat under surplus conditions + Behavior and Interpretation ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Describe the main behavior in practical terms. @@ -268,12 +309,8 @@ Include only assumptions that matter for: - model setup, - understanding the documented workflow. -Limitations -~~~~~~~~~~~ -Use short bullets. - -State what the page intentionally simplifies or does not cover. -Point readers to more specific sections when relevant. +For ``Control`` pages, state that storage behavior is constrained by effective charging/discharging +capability and that this capability depends on the current fill level/state of charge. Related Documentation ~~~~~~~~~~~~~~~~~~~~~ @@ -320,6 +357,14 @@ See [Documentation Architecture](../instructions/documentation-architecture.inst - Avoid implementation-oriented wording unless needed to anchor behavior. - Avoid unnecessary bullets outside assumptions, limitations, and short checklists. +For ``Control`` page Key Concepts specifically: +- Each concept must be formatted as a definition-list entry (bold concept name followed by indented definition). +- Do not use code blocks, boxed elements, or literal formatting for concept definitions. +- Do not use ``::`` or ``|`` markers within definition text. +- Keep each definition to 1–2 concise sentences. +- Do not nest concepts within examples or use numbered/bulleted lists within concept definitions. +- For multi-line definitions, maintain consistent indentation across all lines to prevent reStructuredText from treating the text as a literal block (which would create a box). + reStructuredText requirements ----------------------------- See [Documentation Architecture](../instructions/documentation-architecture.instructions.md) for the shared output-format requirements. In addition: @@ -349,4 +394,11 @@ After writing or updating the file: 7. Check that the page introduces no documentation build warnings or errors. 8. If command execution or validation tools are available, run ``doc/run_spinx.bat`` or the repository-preferred documentation build command. 9. If an error or warning is found, fix it before returning the final content. -10. Do not finish with known syntax errors, broken headings, malformed math blocks, broken references, or unresolved build warnings caused by the change. \ No newline at end of file +10. Do not finish with known syntax errors, broken headings, malformed math blocks, broken references, or unresolved build warnings caused by the change. + +For ``Control`` pages specifically, also verify: +- All required concepts (Network Controller, Subnetworks, Consumers, Producers, Storages, Heat-transfer assets, Setpoints, Priority) are present in the Key Concepts section. +- Priority concept is clearly defined as related to dispatch ordering when producer output is capped. +- No ``Limitations`` section is present; the page proceeds directly from ``Assumptions`` to ``Related Documentation``. +- All Key Concept definitions are formatted as definition-list entries (bold name, indented definition) with no code blocks or boxes. +- Specifically verify that the Storages concept definition does NOT appear in a box; its text should flow naturally as a continuation of the definition line. \ No newline at end of file diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 00000000..0febd684 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,36 @@ +name: "Sphinx: Render docs" + +on: [push] + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + - uses: actions/setup-python@v6 + with: + python-version: "3.11" + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r doc/requirements.txt + pip install -e . + - name: Build HTML + run: | + cd doc + make html + - name: Upload artifacts + uses: actions/upload-artifact@v4 + with: + name: html-docs + path: doc/_build/html/ + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: github.ref == 'refs/heads/main' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: doc/_build/html diff --git a/doc/controller/controller_behavior.rst b/doc/controller/controller_behavior.rst index da26c94a..144fb14e 100644 --- a/doc/controller/controller_behavior.rst +++ b/doc/controller/controller_behavior.rst @@ -1,30 +1,24 @@ Controller Behavior =================== -Overview --------- - -This page describes the network-level controller behavior that runs once per simulation timestep. -It explains how the controller groups assets into controllable subnetworks, balances consumer -requests against producer and storage capability, and writes per-asset setpoints that the network -solver then applies. - -The controller does not solve hydraulics or asset-internal thermodynamics itself. Instead, it -decides target heat transfer, temperatures, bypass use for heat-transfer assets, and which asset in -each hydraulic part of the system becomes the pressure-setting boundary. The solved network state -then determines the resulting mass flows, pressures, temperatures, and any difference between -requested and delivered heat. - -The timestep control path is centered on ``NetworkController.update_setpoints()``. It converts all -local subnetwork demand and capacity to a common basis, performs a system-level heat balance, then -projects the resulting dispatch back onto producers, consumers, storages, and heat-transfer assets. -The controller therefore decides requested operation, while the network and physics models decide -the physically realized state. +Description +----------- + +This page documents what the network-level controller decides in each simulation timestep and how +those decisions affect the solved thermal and hydraulic state. + +The controller groups assets into hydraulically separated controller subnetworks, converts local +demand and capacity to a common basis, applies a system-level dispatch rule, then writes per-asset +setpoints for producers, consumers, storages, and heat-transfer assets. + +It does not solve network hydraulics or asset-internal thermodynamics. Instead, it defines thermal +and pressure-related boundary requests that are applied by the network and physics models in the +next solve step. Control Inputs -------------- -The network-level controller reads the following inputs each timestep. +The network-level dispatch reads the following quantities each timestep. .. list-table:: :header-rows: 1 @@ -32,290 +26,226 @@ The network-level controller reads the following inputs each timestep. * - Input - Description - Unit - * - Consumer heat demand profile - - Requested consumer heat demand from each consumer controller at the current timestep + * - Consumer heat-demand profile + - Requested thermal demand from each consumer controller at the current timestep, clipped by + the consumer ``max_power`` in the consumer controller - W - * - Producer maximum power - - Available thermal output from each producer at the current timestep + * - Producer available power + - Maximum producer thermal output at the current timestep from each producer controller - W * - Producer priority - - Integer dispatch priority used when supply must be capped under surplus conditions + - Integer priority used for surplus producer capping when storage charging is saturated - - * - Storage effective maximum charge power - - Available storage charging capability used for surplus allocation + - Current charging capability reported by each storage controller - W * - Storage effective maximum discharge power - - Available storage discharging capability used for shortage allocation + - Current discharging capability reported by each storage controller - W * - Heat-transfer conversion factor - - Factor used to translate heat between subnetworks across a heat exchanger or heat pump + - Asset factor used to convert thermal power between primary and secondary subnetworks - - - * - Heat-pump maximum electrical power - - Optional electrical input limit on a secondary-side heat-pump network + * - Water-to-water heat-pump maximum electrical power + - Optional secondary-side electrical limit used to cap secondary-side thermal request - W * - Controller temperatures - - Fixed inlet and outlet temperature setpoints carried by producer, consumer, storage, and heat-transfer controllers + - Asset controller supply and return temperature setpoints used when writing setpoints - K - * - Previous solved asset state - - State fed back from the solved heat network into producers, consumers, and storages before the next dispatch update + * - Previous solved storage state + - Fill level, buffer temperatures, and timestep fed back to storage controllers before + dispatch so effective charge and discharge capability can be updated - asset-specific Decision Logic -------------- -Control Decomposition Into Subnetworks -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Subnetwork Grouping and Conversion Basis +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The controller is built from hydraulically separated subnetworks created by the ESDL controller -mapper. If the model contains no heat-transfer assets, all consumers, producers, and storages are -placed in one controller network. If heat exchangers or four-port heat pumps are present, the -mapper splits the system into one controller network for each connected hydraulic side and places -the heat-transfer asset on both sides. +The controller receives subnetworks from the controller mapper. If no heat-transfer asset is +present, all producers, consumers, and storages are dispatched in one controller network. +If heat-transfer assets are present, each hydraulic side is represented by a separate controller +network, and heat-transfer assets connect those controller networks by primary and secondary sides. -.. list-table:: - :header-rows: 1 +The mapper enforces a tree-shaped interconnection through heat-transfer assets. Looped +interconnections are rejected, and paths longer than two heat-transfer stages are rejected. - * - Subnetwork element - - Mapping rule - - Consequence for control - * - Consumer, producer, storage - - Assigned to the hydraulic side to which its asset id is connected in the ESDL graph - - Demand, supply, and storage capability are first evaluated locally per hydraulic part - * - Heat exchanger or four-port heat pump, primary side - - Added to the controller network connected to ``_primary`` - - This side can import or export heat depending on the net dispatch direction - * - Heat exchanger or four-port heat pump, secondary side - - Added to the controller network connected to ``_secondary`` - - This side can import or export heat with the configured conversion factor - -The mapper then connects these subnetworks into a tree through shared heat-transfer assets. Looped -connections through heat exchangers or heat pumps are rejected, and connections through more than -two heat-transfer stages are not supported. - -Each subnetwork stores a path to a reference network and a conversion chain -``factor_to_first_network``. The controller multiplies the heat demand, producer capacity, and -storage charge or discharge capacity of that subnetwork by the product of that chain before forming -the system-wide energy balance. For a heat exchanger this factor is the configured efficiency-like -conversion factor; for a heat pump it is the configured COP-like factor on the secondary side and -its inverse when converting back toward the primary side. - -Per-Timestep Control Sequence -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The network-level control path follows a fixed sequence: - -1. Update each subnetwork conversion chain from its path through heat-transfer assets. -2. Convert each subnetwork's consumer demand, producer capacity, and storage charge or discharge - capability to the reference-network basis. -3. Form system totals: +Before balancing demand and supply, each network computes a conversion chain to a reference network +through the path of connected heat-transfer assets. The chain product is used to convert local +consumer demand, producer capacity, and storage charge or discharge capability to one common basis. - .. math:: +In simplified form, for network :math:`i`: - Q_{demand,tot} = \sum_i Q_{demand,i} +.. math:: - .. math:: + F_i = \prod_k f_{i,k} - Q_{supply,tot} = \sum_i Q_{supply,i} +.. math:: -4. Choose one of four dispatch branches: direct surplus, surplus with producer capping, shortage - covered by storage discharge, or shortage with proportional consumer curtailment. -5. Write producer, storage, and consumer setpoints. -6. For subnetworks that contain exactly one heat-transfer connection, derive the corresponding - primary-side and secondary-side setpoints for that heat-transfer asset. -7. Choose one pressure-setting asset per subnetwork and set its pressure flag. + Q_{demand,i}^{ref} = F_i Q_{demand,i}, \quad + Q_{supply,i}^{ref} = F_i Q_{supply,i}, \quad + Q_{storage,i}^{ref} = F_i Q_{storage,i} -Dispatch Logic for Supply, Demand, and Storage -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +where :math:`f_{i,k}` is the factor contributed by each heat-transfer step in the path. -The controller first compares converted total producer capability with converted total consumer -demand. +Per-Timestep Dispatch Sequence +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If +For each timestep, the network controller applies this sequence: -.. math:: +1. Update network conversion chains. +2. Compute converted totals: - Q_{supply,tot} > Q_{demand,tot} + .. math:: -the system has surplus producer capability. All consumers are assigned their requested demand. The -remaining surplus + Q_{demand,tot} = \sum_i Q_{demand,i}^{ref} -.. math:: - - Q_{surplus} = Q_{supply,tot} - Q_{demand,tot} + .. math:: -is then compared with total effective storage charge capability. + Q_{supply,tot} = \sum_i Q_{supply,i}^{ref} -If storage can absorb the full surplus, all producers are set to maximum output and the controller -allocates storage charging proportionally to available charge power: +3. Choose the dispatch branch from the demand-versus-supply comparison. +4. Write producer, consumer, and storage heat-demand setpoints. +5. Derive setpoints for subnetworks with exactly one connected heat-transfer side. +6. Select one pressure-setting asset per subnetwork. -.. math:: +Dispatch Logic for Supply, Demand, and Storage +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - f_{charge} = \frac{Q_{surplus}}{\sum_i Q_{charge,max,i}} +The first branch condition is: .. math:: - Q_{storage,i} = f_{charge} Q_{charge,max,i} - -with positive heat demand, meaning heat is taken from the network and stored. - -If storage cannot absorb the full surplus, all storages are charged at maximum and producers are -capped by priority. The controller fills producer groups in ascending priority order until the -required supply is reached. If the last active priority group would overshoot the required supply, -that entire group is scaled by a common factor while higher-priority groups are set to zero. + Q_{supply,tot} > Q_{demand,tot} -If +If true, all consumers are set to requested demand and the surplus is: .. math:: - Q_{supply,tot} \leq Q_{demand,tot} - -the system is short of direct producer capability. The controller compares total producer capability -plus total effective storage discharge capability against demand. + Q_{surplus} = Q_{supply,tot} - Q_{demand,tot} -If +The controller compares this surplus to total effective storage charge capability: .. math:: - Q_{supply,tot} + Q_{discharge,tot} > Q_{demand,tot} + Q_{ch,tot} = \sum_i Q_{ch,max,i}^{ref} -all consumers keep their requested demand, all producers are set to maximum, and storage discharge -supplies the residual shortage: +If :math:`Q_{ch,tot} > Q_{surplus}`, producers are set to maximum and storage charging is +allocated proportionally: .. math:: - Q_{shortage} = Q_{demand,tot} - Q_{supply,tot} + f_{ch} = \frac{Q_{surplus}}{Q_{ch,tot}}, \quad + Q_{storage,i} = f_{ch} Q_{ch,max,i} -.. math:: +If :math:`Q_{ch,tot} \leq Q_{surplus}`, all storages charge at maximum and producer output is +capped by priority to match demand plus maximum storage charge. - f_{discharge} = \frac{Q_{shortage}}{\sum_i Q_{discharge,max,i}} +If :math:`Q_{supply,tot} \leq Q_{demand,tot}`, the controller evaluates shortage support from +storage discharge: .. math:: - Q_{storage,i} = -f_{discharge} Q_{discharge,max,i} + Q_{dis,tot} = \sum_i Q_{dis,max,i}^{ref} -with negative heat demand, meaning heat is injected from storage into the network. - -If +If :math:`Q_{supply,tot} + Q_{dis,tot} > Q_{demand,tot}`, all consumers keep requested demand, +all producers are set to maximum, and storage discharge supplies the residual shortage: .. math:: - Q_{supply,tot} + Q_{discharge,tot} \leq Q_{demand,tot} - -the controller cannot meet total demand even with full storage discharge. It therefore sets all -producers and storages to maximum delivery and scales every consumer by the same curtailment factor: + Q_{short} = Q_{demand,tot} - Q_{supply,tot} .. math:: - f_{curtail} = \frac{Q_{supply,tot} + Q_{discharge,tot}}{Q_{demand,tot}} + f_{dis} = \frac{Q_{short}}{Q_{dis,tot}}, \quad + Q_{storage,i} = - f_{dis} Q_{dis,max,i} -.. math:: +If :math:`Q_{supply,tot} + Q_{dis,tot} \leq Q_{demand,tot}`, all producers and storages are set +to maximum delivery and consumer demand is proportionally curtailed: - Q_{consumer,i} = f_{curtail} Q_{consumer,requested,i} +.. math:: -This is a system-wide proportional curtailment rule on the converted-demand basis. + f_{curtail} = \frac{Q_{supply,tot} + Q_{dis,tot}}{Q_{demand,tot}}, \quad + Q_{consumer,i} = f_{curtail} Q_{consumer,i}^{req} -The controller uses the asset sign convention implemented by ``ControllerNetwork``: +Storage fill-level effect on effective capability +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- Consumer heat demand is positive, representing heat extraction from the network. -- Storage charging is positive, representing heat moving from the network into storage. -- Producer dispatch is negative, representing heat injected from the producer into the network. -- Storage discharge is negative, representing heat injected from storage into the network. +The dispatch branches above use effective storage capability, not only configured +``max_charge_power`` and ``max_discharge_power``. -Heat-Transfer Asset Handling Across Primary and Secondary Networks -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +For ``ControllerIdealHeatStorage``, effective capability is updated from the solved previous state +before dispatch. In practical terms: -After producer, consumer, and storage setpoints are assembled, the controller derives setpoints for -heat exchangers and four-port heat pumps on subnetworks that have exactly one heat-transfer asset -connected on either the primary or secondary side. For such a subnetwork it forms the algebraic sum -of all already assigned producer, consumer, and storage heat-demand setpoints: +- charge capability decreases as available cold volume shrinks near full fill level, +- discharge capability decreases as available hot volume shrinks near empty fill level, +- both capabilities are also limited by current hot-cold temperature difference and timestep. -.. math:: +This means the controller clips storage participation near empty or full bounds even when nominal +power ratings are high. As a result, producer capping (in surplus) or consumer curtailment +(in shortage) can start earlier than expected from nominal ratings alone. - Q_{net} = \sum Q_{producer} + \sum Q_{consumer} + \sum Q_{storage} +For storage-internal relations and symbol definitions, see +:doc:`../physics/ideal_heat_storage_physics`. -The sign of ``Q_net`` determines the direction of transfer. +Heat-Transfer Conversion and Water-to-Water Heat-Pump Limit +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -For a network that sees the heat-transfer asset on its primary side: +After producer, consumer, and storage setpoints are assembled, each subnetwork with exactly one +connected heat-transfer side computes net local request: -- If ``Q_net < 0``, the primary side must deliver heat into that subnetwork. The controller calls - ``set_asset_prim(Q_net, bypass=False)``. -- If ``Q_net >= 0``, the primary side does not need conversion-assisted delivery into that - subnetwork. The controller calls ``set_asset_prim(Q_net, bypass=True)``. +.. math:: -For a network that sees the heat-transfer asset on its secondary side: + Q_{net} = \sum Q_{producer} + \sum Q_{consumer} + \sum Q_{storage} -- If ``Q_net < 0``, the secondary side must deliver heat into that subnetwork. The controller calls - ``set_asset_sec(Q_net, bypass=True)``. -- If ``Q_net >= 0``, the secondary side must absorb heat and the controller calls - ``set_asset_sec(Q_net, bypass=False)``. +The sign of :math:`Q_{net}` determines whether conversion is active or bypassed when writing +primary-side and secondary-side setpoints. -With conversion active, the heat-transfer asset writes paired primary-side and secondary-side heat -demands using its configured factor. In simplified form: +With conversion active, the controller writes paired thermal requests using the configured factor +:math:`f`: .. math:: Q_{sec} = f Q_{prim} -or, when dispatch is defined from the secondary side, +or, when the request is defined on the secondary side, .. math:: Q_{prim} = \frac{Q_{sec}}{f} -where ``f`` is the exchanger efficiency-like factor or the heat-pump COP-like factor used by the -controller. - -Heat-Pump Electrical Power Constraint on a Secondary Network -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The controller includes one additional rule for a subnetwork that contains exactly one -secondary-side heat-pump connection with a configured maximum electrical power. Before writing the -heat-transfer setpoints, it checks whether the requested thermal exchange on that secondary network -would exceed the electrical limit: +For a secondary-side water-to-water heat-pump connection with a configured electrical limit, +the controller applies: .. math:: Q_{sec,max} = P_{el,max} f -If - -.. math:: - - |Q_{net}| > Q_{sec,max} - -the controller proportionally scales only the consumers in that subnetwork: - -.. math:: - - f_{hp} = \frac{Q_{sec,max}}{|Q_{net}|} +If :math:`|Q_{net}| > Q_{sec,max}`, consumers in that subnetwork are proportionally scaled: .. math:: + f_{hp} = \frac{Q_{sec,max}}{|Q_{net}|}, \quad Q_{consumer,i,new} = f_{hp} Q_{consumer,i,old} -After this rescaling it recomputes the network heat balance and only then generates the heat-pump -primary-side and secondary-side setpoints. This means the electrical limit is enforced on the -secondary-network thermal request before the asset-level heat-pump physics is solved. +The heat-transfer setpoints are then recalculated from the rescaled subnetwork request. -Pressure-Setting Behavior -~~~~~~~~~~~~~~~~~~~~~~~~~ +Pressure-Setting Asset Selection +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Each subnetwork must contribute one pressure-setting boundary. ``ControllerNetwork.set_pressure()`` -selects that asset by fixed precedence: +Each controller subnetwork must provide one pressure-setting boundary. Selection precedence is: -1. First producer in the subnetwork, if any. -2. Otherwise the first secondary-side heat-transfer asset in the subnetwork. -3. Otherwise the first storage in the subnetwork. +1. first producer in the subnetwork, +2. otherwise first secondary-side heat-transfer asset, +3. otherwise first storage asset. -The selected setpoint key is ``set_pressure`` for producers and storages, or -``secondary_set_pressure`` for a secondary-side heat-transfer asset. No primary-side heat-transfer -asset is selected directly by this rule. +The controller sets the selected pressure flag key to ``True`` and leaves other pressure flags +``False``. Setpoints Produced ------------------ -The network-level controller returns a per-asset dictionary keyed by asset id and controlled -property. +The controller returns a dictionary keyed by asset identifier with the following setpoint keys. .. list-table:: :header-rows: 1 @@ -324,154 +254,168 @@ property. - Description - Unit * - ``heat_demand`` - - Producer, consumer, or storage thermal setpoint on a single hydraulic network + - Thermal request for producer, consumer, or storage assets - W * - ``temperature_in`` - - Asset inlet temperature setpoint used by the receiving asset model + - Inlet temperature setpoint for producer, consumer, or storage assets - K * - ``temperature_out`` - - Asset outlet temperature setpoint used by the receiving asset model + - Outlet temperature setpoint for producer, consumer, or storage assets - K * - ``set_pressure`` - - Pressure-setting flag for a producer or storage selected as the hydraulic reference + - Pressure-setting flag for selected producer or storage asset - - * - ``primary_heat_demand`` - - Heat-transfer asset primary-side thermal setpoint + - Primary-side heat-transfer thermal request - W * - ``primary_temperature_in`` - - Heat-transfer asset primary-side inlet temperature setpoint + - Primary-side inlet temperature setpoint for heat-transfer asset - K * - ``primary_temperature_out`` - - Heat-transfer asset primary-side outlet temperature setpoint + - Primary-side outlet temperature setpoint for heat-transfer asset - K + * - ``primary_set_pressure`` + - Primary-side pressure flag on heat-transfer asset setpoint payload + - - * - ``secondary_heat_demand`` - - Heat-transfer asset secondary-side thermal setpoint + - Secondary-side heat-transfer thermal request - W * - ``secondary_temperature_in`` - - Heat-transfer asset secondary-side inlet temperature setpoint + - Secondary-side inlet temperature setpoint for heat-transfer asset - K * - ``secondary_temperature_out`` - - Heat-transfer asset secondary-side outlet temperature setpoint + - Secondary-side outlet temperature setpoint for heat-transfer asset - K * - ``secondary_set_pressure`` - - Pressure-setting flag when the hydraulic reference is a secondary-side heat-transfer asset + - Secondary-side pressure-setting flag for selected heat-transfer asset - - * - ``bypass`` - - Flag indicating whether the heat-transfer asset should bypass conversion and pass the request through directly + - Flag controlling whether conversion factor is bypassed for the heat-transfer request - - Physical Impact --------------- -Practical Effects on the Solved Hydraulic and Thermal State -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Demand Satisfaction and Curtailment Consequences +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The controller writes requested thermal operation, but the solved network determines the resulting -mass flows, temperatures, and pressures. The physical impact of the controller is therefore best -read as a change in boundary conditions for the next network solve. +Decision: +When :math:`Q_{supply,tot} + Q_{dis,tot} \leq Q_{demand,tot}`, the controller proportionally +curtails all consumers. -Consumer Delivery Under Shortage -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Governing relation: -When the system enters the shortage branch, every consumer request is reduced by the same scalar -factor. The practical consequence is that unmet demand is distributed proportionally across all -consumers rather than by location, priority, or hydraulic accessibility. +.. math:: -For interpreting results this means: + Q_{consumer,i} = f_{curtail} Q_{consumer,i}^{req}, \quad + f_{curtail} = \frac{Q_{supply,tot} + Q_{dis,tot}}{Q_{demand,tot}} -- a consumer can receive less heat because of explicit controller curtailment before the network is solved, -- and the solved delivery can differ further from the curtailed request if hydraulics or available temperatures prevent exact realization. +Practical consequence: +The requested heat presented to the network is reduced before solving hydraulics. Reported +delivered heat may be lower still if hydraulic or thermal conditions cannot realize the curtailed +request exactly. For consumer asset-level behavior, see :doc:`../physics/consumer_physics`. -For the asset-level heat-to-mass-flow relation and reported delivered heat, see -:doc:`../physics/consumer_physics`. +Storage Clipping and Dispatch Branch Switching +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Producer Dispatch and Capping -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Decision: +Storage contribution is bounded by effective charge and discharge capability derived from current +state. -Producer dispatch controls how much thermal power is made available to the network and whether a -producer participates at all in a surplus case. When producer priorities are used to cap supply, -lower-priority groups can remain fully loaded while the marginal priority group is uniformly scaled -and higher-priority groups are forced to zero. +Governing relation: -This affects the solved hydraulic state because the active set of pressure-driven or -mass-flow-imposing producers changes between timesteps. As a result, flow magnitudes and pressure -distribution can shift even when total delivered demand is unchanged. For the producer-side physics -of heat injection and pressure-controlled operation, see :doc:`../physics/producer_physics`. +.. math:: -Storage Charge and Discharge Allocation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Q_{storage,i} = f Q_{storage,max,i}^{eff} -Storage participation is limited by the effective maximum charge and discharge powers provided by -the storage controllers. The network-level controller allocates surplus charging or shortage -discharge in proportion to these effective powers: +where :math:`Q_{storage,max,i}^{eff}` is the current effective limit used by dispatch. -.. math:: +Practical consequence: +As storages approach full or empty conditions, effective capability clips and less thermal buffering +is available to balance mismatch. This can trigger producer capping in surplus periods or consumer +curtailment in shortage periods. For storage-internal equations, see +:doc:`../physics/ideal_heat_storage_physics` and :doc:`../physics/ates_cluster_physics`. - Q_{storage,i} = f Q_{storage,max,i} +Heat-Transfer Setpoints and Inter-Network Balance +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This means storage is not dispatched by cost, state-of-charge optimization, or location-specific -hydraulic advantage. It is clipped only by available effective charge or discharge power and then -shared proportionally across all participating storages. +Decision: +The controller converts net subnetwork request into paired primary-side and secondary-side +setpoints, optionally with bypass. -The practical consequence is that storage can absorb or release only as much heat as its current -controller state allows. Once that capability is exhausted, additional surplus forces producer -capping and additional shortage forces consumer curtailment. For ATES-side physical interpretation, -see :doc:`../physics/ates_cluster_physics`. +Governing relation: -Heat-Transfer Conversion Between Networks -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. math:: + + Q_{sec} = f Q_{prim} -Heat-transfer assets connect hydraulic subnetworks while changing the thermal power seen on each -side according to the configured conversion factor. The controller first balances the system on a -common reference basis and then writes paired primary-side and secondary-side requests. A secondary -network can therefore show larger thermal throughput than its connected primary network when a heat -pump COP greater than one is active. +Practical consequence: +Thermal request is redistributed between hydraulic subnetworks according to conversion factor, so +the solved mass flow and temperature levels on each side can differ while still satisfying the +controller-level converted balance. For water-to-water heat-pump asset physics, see +:doc:`../physics/heat_pump_physics`. -The direction of the net subnetwork demand also determines whether conversion is active or a bypass -flag is written. That choice changes whether the solved model interprets the coupling as factor- -based transfer between networks or as a direct pass-through request on both sides. For the four- -port heat-pump asset physics, see :doc:`../physics/heat_pump_physics`. For two-port heat pumps -modeled as producers, see :doc:`../physics/air_to_water_heat_pump_physics`. +Pressure Boundary Selection +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Pressure-Setting Choice -~~~~~~~~~~~~~~~~~~~~~~~ +Decision: +One asset per subnetwork is marked as pressure-setting by fixed precedence. -The pressure flag selects which asset anchors each hydraulic subnetwork. This is the controller's -only direct pressure decision. All other pressures arise from the network solve. Changing which -asset carries the pressure flag changes the boundary condition used by the hydraulic model and can -therefore alter solved flow distribution and pressure levels throughout that subnetwork, even if the -same total heat setpoints are requested. +Governing relation: +The controller sets one pressure flag key to ``True`` per subnetwork. -For broader network interpretation, see :doc:`../network/network_main`. +Practical consequence: +The selected asset becomes the hydraulic pressure boundary for that subnetwork solve. Changing this +selection changes hydraulic boundary conditions and can alter solved pressure and flow distribution. +For network-level interpretation, see :doc:`../network/network_main`. Assumptions ----------- -- Control decisions are instantaneous within a timestep; the controller has no internal ramping, startup, or shutdown dynamics. -- Consumer demand profiles and producer maximum powers are treated as known for the current timestep. -- System-wide balancing is performed on converted thermal power totals, not on a hydraulic feasibility check before dispatch. -- Storage allocation is proportional to effective charge or discharge capability. -- Consumer curtailment under shortage is proportional across all consumers. -- Pressure selection uses a fixed precedence rule rather than an optimization or hydraulic-quality criterion. +- Controller decisions are instantaneous within a timestep. +- Demand profiles and available producer power are treated as known at dispatch time. +- Dispatch balancing is performed on converted thermal power totals, not on a prior hydraulic + feasibility optimization. +- Storage participation is allocated proportionally to effective capability. +- Consumer curtailment is proportional across consumers when total supply is insufficient. +- Pressure-setting selection follows fixed precedence, not an optimization criterion. Limitations ----------- -- The network grouping built by the controller mapper must form a tree through heat-transfer assets; looped heat-transfer topologies are not supported. -- Connections through more than two heat-transfer stages are rejected. -- Heat-transfer setpoints are only derived for subnetworks that contain exactly one connected heat-transfer asset side. -- The producer-capping rule uses integer priorities only and does not include cost, emissions, or efficiency optimization. -- The secondary-side heat-pump electrical constraint is enforced by scaling consumers in that subnetwork; it does not re-optimize the rest of the system dispatch. -- The network-level controller does not guarantee that the solved hydraulic or thermal state can realize every requested setpoint exactly. +- Heat-transfer-connected controller networks must form a tree; looped topologies are not + supported. +- Paths through more than two heat-transfer stages are not supported. +- Heat-transfer setpoints are generated only for subnetworks with exactly one connected + heat-transfer side. +- Surplus producer capping uses integer priority groups only; no cost or emission optimization is + performed. +- The secondary-side water-to-water heat-pump electrical constraint is enforced by local consumer + scaling in that subnetwork. +- Controller setpoints are requests; the solved network may realize different delivered values + because of hydraulic and thermal constraints. Related Documentation --------------------- -- :doc:`../controller/controller` for the conceptual control overview. -- :doc:`../network/network_main` for how controller setpoints become solved network states. -- :doc:`../physics/producer_physics` for producer-side heat injection behavior. -- :doc:`../physics/consumer_physics` for consumer-side heat extraction behavior. -- :doc:`../physics/ates_cluster_physics` for ATES storage physics. -- :doc:`../physics/heat_pump_physics` for four-port heat-pump behavior across primary and secondary networks. -- :doc:`../physics/air_to_water_heat_pump_physics` for two-port heat pumps mapped as producers. -- :doc:`../reference/controller_reference` for controller implementation reference. \ No newline at end of file +For the conceptual controller overview and workflow placement, see +:doc:`controller`. + +For network-level interpretation of how controller setpoints are realized, see +:doc:`../network/network_main`. + +For storage and heat-pump asset physics that constrain effective behavior, see +:doc:`../physics/ideal_heat_storage_physics` and +:doc:`../physics/heat_pump_physics`. + +For implementation-oriented controller reference, see +:doc:`../reference/controller_reference`. + +- :doc:`controller` for the conceptual control overview. +- :doc:`../physics/ideal_heat_storage_physics` for ideal heat-storage internal clipping behavior. +- :doc:`../physics/ates_cluster_physics` for ATES storage behavior. +- :doc:`../physics/producer_physics` for producer asset physical response. +- :doc:`../physics/consumer_physics` for consumer asset physical response. +- :doc:`../physics/heat_pump_physics` for water-to-water heat-pump internal behavior. +- :doc:`../network/network_main` for network solve interpretation. +- :doc:`../reference/controller_reference` for class-level reference. diff --git a/doc/create_env.bat b/doc/create_venv.bat similarity index 100% rename from doc/create_env.bat rename to doc/create_venv.bat diff --git a/doc/developer/api/omotes_simulator_core.adapter.presentation.rst b/doc/developer/api/omotes_simulator_core.adapter.presentation.rst index f9d69415..a34bf977 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.presentation.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.presentation.rst @@ -3,5 +3,5 @@ adapter.presentation .. automodule:: omotes_simulator_core.adapter.presentation :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.rst b/doc/developer/api/omotes_simulator_core.adapter.rst index 171709a6..0b13bb1f 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.rst @@ -3,8 +3,8 @@ adapter .. automodule:: omotes_simulator_core.adapter :members: - :undoc-members: :show-inheritance: + :undoc-members: Subpackages ----------- diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mapper.rst index aa55e3bb..073b1307 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.controller_mapper .. automodule:: omotes_simulator_core.adapter.transforms.controller_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_consumer_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_consumer_mapper.rst index bc1fb95b..2af2617d 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_consumer_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_consumer_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.controller_mappers.controller_consumer_mapper .. automodule:: omotes_simulator_core.adapter.transforms.controller_mappers.controller_consumer_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_heat_transfer_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_heat_transfer_mapper.rst index 5e315727..eee2fb59 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_heat_transfer_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_heat_transfer_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.controller_mappers.controller_heat_transfer_mapper .. automodule:: omotes_simulator_core.adapter.transforms.controller_mappers.controller_heat_transfer_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_producer_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_producer_mapper.rst index d6ef2a25..31190322 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_producer_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_producer_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.controller_mappers.controller_producer_mapper .. automodule:: omotes_simulator_core.adapter.transforms.controller_mappers.controller_producer_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_storage_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_storage_mapper.rst index bd73b5be..301de6ef 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_storage_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.controller_storage_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.controller_mappers.controller_storage_mapper .. automodule:: omotes_simulator_core.adapter.transforms.controller_mappers.controller_storage_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.rst index 3b88665d..f6b11b93 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.controller_mappers.rst @@ -3,8 +3,8 @@ adapter.transforms.controller_mappers .. automodule:: omotes_simulator_core.adapter.transforms.controller_mappers :members: - :undoc-members: :show-inheritance: + :undoc-members: Submodules ---------- diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mapper.rst index 9d1a314d..6597a48d 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.esdl_asset_mapper .. automodule:: omotes_simulator_core.adapter.transforms.esdl_asset_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.ates_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.ates_mapper.rst index 9a35f830..cc200542 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.ates_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.ates_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.esdl_asset_mappers.ates_mapper .. automodule:: omotes_simulator_core.adapter.transforms.esdl_asset_mappers.ates_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.consumer_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.consumer_mapper.rst index 56945b4a..980d67b1 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.consumer_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.consumer_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.esdl_asset_mappers.consumer_mapper .. automodule:: omotes_simulator_core.adapter.transforms.esdl_asset_mappers.consumer_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.heat_exchanger_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.heat_exchanger_mapper.rst index a50facbf..82f367ae 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.heat_exchanger_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.heat_exchanger_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.esdl_asset_mappers.heat_exchanger_mapper .. automodule:: omotes_simulator_core.adapter.transforms.esdl_asset_mappers.heat_exchanger_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.heat_pump_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.heat_pump_mapper.rst index e7c5d837..69e73f84 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.heat_pump_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.heat_pump_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.esdl_asset_mappers.heat_pump_mapper .. automodule:: omotes_simulator_core.adapter.transforms.esdl_asset_mappers.heat_pump_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.ideal_heat_storage_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.ideal_heat_storage_mapper.rst index 4a5d5549..0ad4a7bb 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.ideal_heat_storage_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.ideal_heat_storage_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.esdl_asset_mappers.ideal_heat_storage_mapper .. automodule:: omotes_simulator_core.adapter.transforms.esdl_asset_mappers.ideal_heat_storage_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.pipe_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.pipe_mapper.rst index 2b20e28d..88ea3770 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.pipe_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.pipe_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.esdl_asset_mappers.pipe_mapper .. automodule:: omotes_simulator_core.adapter.transforms.esdl_asset_mappers.pipe_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.producer_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.producer_mapper.rst index e9f969d5..23073b85 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.producer_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.producer_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.esdl_asset_mappers.producer_mapper .. automodule:: omotes_simulator_core.adapter.transforms.esdl_asset_mappers.producer_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.rst index b64c1ef3..51f077ff 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_asset_mappers.rst @@ -3,8 +3,8 @@ adapter.transforms.esdl_asset_mappers .. automodule:: omotes_simulator_core.adapter.transforms.esdl_asset_mappers :members: - :undoc-members: :show-inheritance: + :undoc-members: Submodules ---------- diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_graph_mapper.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_graph_mapper.rst index ed9e6e1a..6abc49df 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_graph_mapper.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.esdl_graph_mapper.rst @@ -3,5 +3,5 @@ adapter.transforms.esdl_graph_mapper .. automodule:: omotes_simulator_core.adapter.transforms.esdl_graph_mapper :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.mappers.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.mappers.rst index 02bb9599..ae7bb5df 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.mappers.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.mappers.rst @@ -3,5 +3,5 @@ adapter.transforms.mappers .. automodule:: omotes_simulator_core.adapter.transforms.mappers :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.rst index 4e507c34..c82b659c 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.rst @@ -3,8 +3,8 @@ adapter.transforms .. automodule:: omotes_simulator_core.adapter.transforms :members: - :undoc-members: :show-inheritance: + :undoc-members: Subpackages ----------- diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.string_to_esdl.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.string_to_esdl.rst index 41aeed7c..a3d9f153 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.string_to_esdl.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.string_to_esdl.rst @@ -3,5 +3,5 @@ adapter.transforms.string_to_esdl .. automodule:: omotes_simulator_core.adapter.transforms.string_to_esdl :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.transforms.transform_utils.rst b/doc/developer/api/omotes_simulator_core.adapter.transforms.transform_utils.rst index b9fe9a4e..5108aa86 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.transforms.transform_utils.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.transforms.transform_utils.rst @@ -3,5 +3,5 @@ adapter.transforms.transform_utils .. automodule:: omotes_simulator_core.adapter.transforms.transform_utils :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.utility.graph.rst b/doc/developer/api/omotes_simulator_core.adapter.utility.graph.rst index 4fdd5dd4..9006ef5b 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.utility.graph.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.utility.graph.rst @@ -3,5 +3,5 @@ adapter.utility.graph .. automodule:: omotes_simulator_core.adapter.utility.graph :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.adapter.utility.rst b/doc/developer/api/omotes_simulator_core.adapter.utility.rst index 4f6c6066..66d06c1d 100644 --- a/doc/developer/api/omotes_simulator_core.adapter.utility.rst +++ b/doc/developer/api/omotes_simulator_core.adapter.utility.rst @@ -3,8 +3,8 @@ adapter.utility .. automodule:: omotes_simulator_core.adapter.utility :members: - :undoc-members: :show-inheritance: + :undoc-members: Submodules ---------- diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.air_to_water_heat_pump.rst b/doc/developer/api/omotes_simulator_core.entities.assets.air_to_water_heat_pump.rst index 34c3db36..da93625e 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.air_to_water_heat_pump.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.air_to_water_heat_pump.rst @@ -3,5 +3,5 @@ entities.assets.air_to_water_heat_pump .. automodule:: omotes_simulator_core.entities.assets.air_to_water_heat_pump :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.asset_abstract.rst b/doc/developer/api/omotes_simulator_core.entities.assets.asset_abstract.rst index 801a483d..332170b5 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.asset_abstract.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.asset_abstract.rst @@ -3,5 +3,5 @@ entities.assets.asset_abstract .. automodule:: omotes_simulator_core.entities.assets.asset_abstract :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.asset_defaults.rst b/doc/developer/api/omotes_simulator_core.entities.assets.asset_defaults.rst index 561400bb..fdbce10f 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.asset_defaults.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.asset_defaults.rst @@ -3,5 +3,5 @@ entities.assets.asset_defaults .. automodule:: omotes_simulator_core.entities.assets.asset_defaults :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.ates_cluster.rst b/doc/developer/api/omotes_simulator_core.entities.assets.ates_cluster.rst index 667ac1c8..799428f4 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.ates_cluster.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.ates_cluster.rst @@ -3,5 +3,5 @@ entities.assets.ates_cluster .. automodule:: omotes_simulator_core.entities.assets.ates_cluster :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.controller.asset_controller_abstract.rst b/doc/developer/api/omotes_simulator_core.entities.assets.controller.asset_controller_abstract.rst index bfc82e4b..0a7eb06c 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.controller.asset_controller_abstract.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.controller.asset_controller_abstract.rst @@ -3,5 +3,5 @@ entities.assets.controller.asset_controller_abstract .. automodule:: omotes_simulator_core.entities.assets.controller.asset_controller_abstract :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_consumer.rst b/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_consumer.rst index 204b8d23..eb1df5ff 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_consumer.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_consumer.rst @@ -3,5 +3,5 @@ entities.assets.controller.controller_consumer .. automodule:: omotes_simulator_core.entities.assets.controller.controller_consumer :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_heat_transfer.rst b/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_heat_transfer.rst index 80e2b7e8..80ea5828 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_heat_transfer.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_heat_transfer.rst @@ -3,5 +3,5 @@ entities.assets.controller.controller_heat_transfer .. automodule:: omotes_simulator_core.entities.assets.controller.controller_heat_transfer :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_network.rst b/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_network.rst index 149be7e6..8cc41847 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_network.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_network.rst @@ -3,5 +3,5 @@ entities.assets.controller.controller_network .. automodule:: omotes_simulator_core.entities.assets.controller.controller_network :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_producer.rst b/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_producer.rst index aeba68ff..7d1ab66c 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_producer.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_producer.rst @@ -3,5 +3,5 @@ entities.assets.controller.controller_producer .. automodule:: omotes_simulator_core.entities.assets.controller.controller_producer :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_storage.rst b/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_storage.rst index f568de52..e8ad1740 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_storage.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.controller.controller_storage.rst @@ -3,5 +3,5 @@ entities.assets.controller.controller_storage .. automodule:: omotes_simulator_core.entities.assets.controller.controller_storage :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.controller.profile_interpolation.rst b/doc/developer/api/omotes_simulator_core.entities.assets.controller.profile_interpolation.rst index 74309b88..69b0d21f 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.controller.profile_interpolation.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.controller.profile_interpolation.rst @@ -3,5 +3,5 @@ entities.assets.controller.profile_interpolation .. automodule:: omotes_simulator_core.entities.assets.controller.profile_interpolation :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.controller.rst b/doc/developer/api/omotes_simulator_core.entities.assets.controller.rst index 69cea2ea..5f88d48d 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.controller.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.controller.rst @@ -3,8 +3,8 @@ entities.assets.controller .. automodule:: omotes_simulator_core.entities.assets.controller :members: - :undoc-members: :show-inheritance: + :undoc-members: Submodules ---------- diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.controller.temperature_data.rst b/doc/developer/api/omotes_simulator_core.entities.assets.controller.temperature_data.rst index a91242e1..669f5a78 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.controller.temperature_data.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.controller.temperature_data.rst @@ -3,5 +3,5 @@ entities.assets.controller.temperature_data .. automodule:: omotes_simulator_core.entities.assets.controller.temperature_data :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.demand_cluster.rst b/doc/developer/api/omotes_simulator_core.entities.assets.demand_cluster.rst index 1f131a95..4bda6a43 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.demand_cluster.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.demand_cluster.rst @@ -3,5 +3,5 @@ entities.assets.demand_cluster .. automodule:: omotes_simulator_core.entities.assets.demand_cluster :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.esdl_asset_object.rst b/doc/developer/api/omotes_simulator_core.entities.assets.esdl_asset_object.rst index c3a82142..3bdb8d29 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.esdl_asset_object.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.esdl_asset_object.rst @@ -3,5 +3,5 @@ entities.assets.esdl_asset_object .. automodule:: omotes_simulator_core.entities.assets.esdl_asset_object :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.heat_exchanger.rst b/doc/developer/api/omotes_simulator_core.entities.assets.heat_exchanger.rst index bcd3efb1..4f30c4ac 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.heat_exchanger.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.heat_exchanger.rst @@ -3,5 +3,5 @@ entities.assets.heat_exchanger .. automodule:: omotes_simulator_core.entities.assets.heat_exchanger :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.heat_pump.rst b/doc/developer/api/omotes_simulator_core.entities.assets.heat_pump.rst index a1b8d2fb..06fc0f4b 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.heat_pump.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.heat_pump.rst @@ -3,5 +3,5 @@ entities.assets.heat_pump .. automodule:: omotes_simulator_core.entities.assets.heat_pump :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.ideal_heat_storage.rst b/doc/developer/api/omotes_simulator_core.entities.assets.ideal_heat_storage.rst index 708a1b85..b36e18bb 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.ideal_heat_storage.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.ideal_heat_storage.rst @@ -3,5 +3,5 @@ entities.assets.ideal_heat_storage .. automodule:: omotes_simulator_core.entities.assets.ideal_heat_storage :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.junction.rst b/doc/developer/api/omotes_simulator_core.entities.assets.junction.rst index 2cd04b63..8fca6261 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.junction.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.junction.rst @@ -3,5 +3,5 @@ entities.assets.junction .. automodule:: omotes_simulator_core.entities.assets.junction :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.pipe.rst b/doc/developer/api/omotes_simulator_core.entities.assets.pipe.rst index 6663e354..c0169322 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.pipe.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.pipe.rst @@ -3,5 +3,5 @@ entities.assets.pipe .. automodule:: omotes_simulator_core.entities.assets.pipe :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.production_cluster.rst b/doc/developer/api/omotes_simulator_core.entities.assets.production_cluster.rst index 98d6a0bc..e7ec0cf9 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.production_cluster.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.production_cluster.rst @@ -3,5 +3,5 @@ entities.assets.production_cluster .. automodule:: omotes_simulator_core.entities.assets.production_cluster :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.pyjnius_loader.rst b/doc/developer/api/omotes_simulator_core.entities.assets.pyjnius_loader.rst index f60fec00..af5d206d 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.pyjnius_loader.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.pyjnius_loader.rst @@ -3,5 +3,5 @@ entities.assets.pyjnius_loader .. automodule:: omotes_simulator_core.entities.assets.pyjnius_loader :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.rst b/doc/developer/api/omotes_simulator_core.entities.assets.rst index 70549670..e3b85d24 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.rst @@ -3,8 +3,8 @@ entities.assets .. automodule:: omotes_simulator_core.entities.assets :members: - :undoc-members: :show-inheritance: + :undoc-members: Subpackages ----------- diff --git a/doc/developer/api/omotes_simulator_core.entities.assets.utils.rst b/doc/developer/api/omotes_simulator_core.entities.assets.utils.rst index b1b69199..708202d1 100644 --- a/doc/developer/api/omotes_simulator_core.entities.assets.utils.rst +++ b/doc/developer/api/omotes_simulator_core.entities.assets.utils.rst @@ -3,5 +3,5 @@ entities.assets.utils .. automodule:: omotes_simulator_core.entities.assets.utils :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.esdl_object.rst b/doc/developer/api/omotes_simulator_core.entities.esdl_object.rst index b612c709..fe7afb0b 100644 --- a/doc/developer/api/omotes_simulator_core.entities.esdl_object.rst +++ b/doc/developer/api/omotes_simulator_core.entities.esdl_object.rst @@ -3,5 +3,5 @@ entities.esdl_object .. automodule:: omotes_simulator_core.entities.esdl_object :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.heat_network.rst b/doc/developer/api/omotes_simulator_core.entities.heat_network.rst index 521372c1..f01d0604 100644 --- a/doc/developer/api/omotes_simulator_core.entities.heat_network.rst +++ b/doc/developer/api/omotes_simulator_core.entities.heat_network.rst @@ -3,5 +3,5 @@ entities.heat_network .. automodule:: omotes_simulator_core.entities.heat_network :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.network_controller.rst b/doc/developer/api/omotes_simulator_core.entities.network_controller.rst index 79813ee0..90dc0873 100644 --- a/doc/developer/api/omotes_simulator_core.entities.network_controller.rst +++ b/doc/developer/api/omotes_simulator_core.entities.network_controller.rst @@ -3,5 +3,5 @@ entities.network_controller .. automodule:: omotes_simulator_core.entities.network_controller :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.network_controller_abstract.rst b/doc/developer/api/omotes_simulator_core.entities.network_controller_abstract.rst index 4081ab89..ec933a43 100644 --- a/doc/developer/api/omotes_simulator_core.entities.network_controller_abstract.rst +++ b/doc/developer/api/omotes_simulator_core.entities.network_controller_abstract.rst @@ -3,5 +3,5 @@ entities.network_controller_abstract .. automodule:: omotes_simulator_core.entities.network_controller_abstract :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.rst b/doc/developer/api/omotes_simulator_core.entities.rst index 7e48513d..a630e40d 100644 --- a/doc/developer/api/omotes_simulator_core.entities.rst +++ b/doc/developer/api/omotes_simulator_core.entities.rst @@ -3,8 +3,8 @@ entities .. automodule:: omotes_simulator_core.entities :members: - :undoc-members: :show-inheritance: + :undoc-members: Subpackages ----------- diff --git a/doc/developer/api/omotes_simulator_core.entities.simulation_configuration.rst b/doc/developer/api/omotes_simulator_core.entities.simulation_configuration.rst index b62e66c7..9c6a6a7b 100644 --- a/doc/developer/api/omotes_simulator_core.entities.simulation_configuration.rst +++ b/doc/developer/api/omotes_simulator_core.entities.simulation_configuration.rst @@ -3,5 +3,5 @@ entities.simulation_configuration .. automodule:: omotes_simulator_core.entities.simulation_configuration :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.utility.influxdb_reader.rst b/doc/developer/api/omotes_simulator_core.entities.utility.influxdb_reader.rst index ec431a4b..d0df7c21 100644 --- a/doc/developer/api/omotes_simulator_core.entities.utility.influxdb_reader.rst +++ b/doc/developer/api/omotes_simulator_core.entities.utility.influxdb_reader.rst @@ -3,5 +3,5 @@ entities.utility.influxdb_reader .. automodule:: omotes_simulator_core.entities.utility.influxdb_reader :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.entities.utility.rst b/doc/developer/api/omotes_simulator_core.entities.utility.rst index 0636ccc9..4ed31cec 100644 --- a/doc/developer/api/omotes_simulator_core.entities.utility.rst +++ b/doc/developer/api/omotes_simulator_core.entities.utility.rst @@ -3,8 +3,8 @@ entities.utility .. automodule:: omotes_simulator_core.entities.utility :members: - :undoc-members: :show-inheritance: + :undoc-members: Submodules ---------- diff --git a/doc/developer/api/omotes_simulator_core.infrastructure.app.rst b/doc/developer/api/omotes_simulator_core.infrastructure.app.rst index 4565d73d..9115c266 100644 --- a/doc/developer/api/omotes_simulator_core.infrastructure.app.rst +++ b/doc/developer/api/omotes_simulator_core.infrastructure.app.rst @@ -3,5 +3,5 @@ infrastructure.app .. automodule:: omotes_simulator_core.infrastructure.app :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.infrastructure.plotting.rst b/doc/developer/api/omotes_simulator_core.infrastructure.plotting.rst index 71b402f2..f2e29bcc 100644 --- a/doc/developer/api/omotes_simulator_core.infrastructure.plotting.rst +++ b/doc/developer/api/omotes_simulator_core.infrastructure.plotting.rst @@ -3,5 +3,5 @@ infrastructure.plotting .. automodule:: omotes_simulator_core.infrastructure.plotting :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.infrastructure.profiling.rst b/doc/developer/api/omotes_simulator_core.infrastructure.profiling.rst index 4d2a7ce0..4275bd99 100644 --- a/doc/developer/api/omotes_simulator_core.infrastructure.profiling.rst +++ b/doc/developer/api/omotes_simulator_core.infrastructure.profiling.rst @@ -3,5 +3,5 @@ infrastructure.profiling .. automodule:: omotes_simulator_core.infrastructure.profiling :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.infrastructure.rst b/doc/developer/api/omotes_simulator_core.infrastructure.rst index 391f0ccd..20a80325 100644 --- a/doc/developer/api/omotes_simulator_core.infrastructure.rst +++ b/doc/developer/api/omotes_simulator_core.infrastructure.rst @@ -3,8 +3,8 @@ infrastructure .. automodule:: omotes_simulator_core.infrastructure :members: - :undoc-members: :show-inheritance: + :undoc-members: Submodules ---------- diff --git a/doc/developer/api/omotes_simulator_core.infrastructure.simulation_manager.rst b/doc/developer/api/omotes_simulator_core.infrastructure.simulation_manager.rst index b7cadd1a..92373e3f 100644 --- a/doc/developer/api/omotes_simulator_core.infrastructure.simulation_manager.rst +++ b/doc/developer/api/omotes_simulator_core.infrastructure.simulation_manager.rst @@ -3,5 +3,5 @@ infrastructure.simulation_manager .. automodule:: omotes_simulator_core.infrastructure.simulation_manager :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.infrastructure.utils.rst b/doc/developer/api/omotes_simulator_core.infrastructure.utils.rst index e6acc92a..fec64c0d 100644 --- a/doc/developer/api/omotes_simulator_core.infrastructure.utils.rst +++ b/doc/developer/api/omotes_simulator_core.infrastructure.utils.rst @@ -3,5 +3,5 @@ infrastructure.utils .. automodule:: omotes_simulator_core.infrastructure.utils :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.rst b/doc/developer/api/omotes_simulator_core.rst index 71d42db3..b94c9b43 100644 --- a/doc/developer/api/omotes_simulator_core.rst +++ b/doc/developer/api/omotes_simulator_core.rst @@ -3,8 +3,8 @@ API Root Index .. automodule:: omotes_simulator_core :members: - :undoc-members: :show-inheritance: + :undoc-members: Subpackages ----------- diff --git a/doc/developer/api/omotes_simulator_core.simulation.mappers.mappers.rst b/doc/developer/api/omotes_simulator_core.simulation.mappers.mappers.rst index b5eede19..df3f7798 100644 --- a/doc/developer/api/omotes_simulator_core.simulation.mappers.mappers.rst +++ b/doc/developer/api/omotes_simulator_core.simulation.mappers.mappers.rst @@ -3,5 +3,5 @@ simulation.mappers.mappers .. automodule:: omotes_simulator_core.simulation.mappers.mappers :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.simulation.mappers.rst b/doc/developer/api/omotes_simulator_core.simulation.mappers.rst index 2f2e9aa7..0f9f5a7b 100644 --- a/doc/developer/api/omotes_simulator_core.simulation.mappers.rst +++ b/doc/developer/api/omotes_simulator_core.simulation.mappers.rst @@ -3,8 +3,8 @@ simulation.mappers .. automodule:: omotes_simulator_core.simulation.mappers :members: - :undoc-members: :show-inheritance: + :undoc-members: Submodules ---------- diff --git a/doc/developer/api/omotes_simulator_core.simulation.networksimulation.rst b/doc/developer/api/omotes_simulator_core.simulation.networksimulation.rst index 4c846971..6da69ffb 100644 --- a/doc/developer/api/omotes_simulator_core.simulation.networksimulation.rst +++ b/doc/developer/api/omotes_simulator_core.simulation.networksimulation.rst @@ -3,5 +3,5 @@ simulation.networksimulation .. automodule:: omotes_simulator_core.simulation.networksimulation :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.simulation.rst b/doc/developer/api/omotes_simulator_core.simulation.rst index 49176eff..84ba9db3 100644 --- a/doc/developer/api/omotes_simulator_core.simulation.rst +++ b/doc/developer/api/omotes_simulator_core.simulation.rst @@ -3,8 +3,8 @@ simulation .. automodule:: omotes_simulator_core.simulation :members: - :undoc-members: :show-inheritance: + :undoc-members: Subpackages ----------- diff --git a/doc/developer/api/omotes_simulator_core.solver.matrix.equation_object.rst b/doc/developer/api/omotes_simulator_core.solver.matrix.equation_object.rst index 117f87e6..7b658bce 100644 --- a/doc/developer/api/omotes_simulator_core.solver.matrix.equation_object.rst +++ b/doc/developer/api/omotes_simulator_core.solver.matrix.equation_object.rst @@ -3,5 +3,5 @@ solver.matrix.equation_object .. automodule:: omotes_simulator_core.solver.matrix.equation_object :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.matrix.index_core_quantity.rst b/doc/developer/api/omotes_simulator_core.solver.matrix.index_core_quantity.rst index 0737f298..eb3672f1 100644 --- a/doc/developer/api/omotes_simulator_core.solver.matrix.index_core_quantity.rst +++ b/doc/developer/api/omotes_simulator_core.solver.matrix.index_core_quantity.rst @@ -3,5 +3,5 @@ solver.matrix.index_core_quantity .. automodule:: omotes_simulator_core.solver.matrix.index_core_quantity :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.matrix.matrix.rst b/doc/developer/api/omotes_simulator_core.solver.matrix.matrix.rst index bc5ec47c..1c340b67 100644 --- a/doc/developer/api/omotes_simulator_core.solver.matrix.matrix.rst +++ b/doc/developer/api/omotes_simulator_core.solver.matrix.matrix.rst @@ -3,5 +3,5 @@ solver.matrix.matrix .. automodule:: omotes_simulator_core.solver.matrix.matrix :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.matrix.rst b/doc/developer/api/omotes_simulator_core.solver.matrix.rst index 41ca3d48..476eb456 100644 --- a/doc/developer/api/omotes_simulator_core.solver.matrix.rst +++ b/doc/developer/api/omotes_simulator_core.solver.matrix.rst @@ -3,8 +3,8 @@ solver.matrix .. automodule:: omotes_simulator_core.solver.matrix :members: - :undoc-members: :show-inheritance: + :undoc-members: Submodules ---------- diff --git a/doc/developer/api/omotes_simulator_core.solver.network.assets.air_to_water_heat_pump.rst b/doc/developer/api/omotes_simulator_core.solver.network.assets.air_to_water_heat_pump.rst index 908af1c6..d9094e12 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.assets.air_to_water_heat_pump.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.assets.air_to_water_heat_pump.rst @@ -3,5 +3,5 @@ solver.network.assets.air_to_water_heat_pump .. automodule:: omotes_simulator_core.solver.network.assets.air_to_water_heat_pump :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.network.assets.base_asset.rst b/doc/developer/api/omotes_simulator_core.solver.network.assets.base_asset.rst index 8cb2d3d6..b856c90f 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.assets.base_asset.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.assets.base_asset.rst @@ -3,5 +3,5 @@ solver.network.assets.base_asset .. automodule:: omotes_simulator_core.solver.network.assets.base_asset :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.network.assets.base_item.rst b/doc/developer/api/omotes_simulator_core.solver.network.assets.base_item.rst index 24ecd7ea..a93486ca 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.assets.base_item.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.assets.base_item.rst @@ -3,5 +3,5 @@ solver.network.assets.base_item .. automodule:: omotes_simulator_core.solver.network.assets.base_item :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.network.assets.base_node_item.rst b/doc/developer/api/omotes_simulator_core.solver.network.assets.base_node_item.rst index 5714e483..3cd988b7 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.assets.base_node_item.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.assets.base_node_item.rst @@ -3,5 +3,5 @@ solver.network.assets.base_node_item .. automodule:: omotes_simulator_core.solver.network.assets.base_node_item :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.network.assets.boundary.rst b/doc/developer/api/omotes_simulator_core.solver.network.assets.boundary.rst index 0338db40..77626244 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.assets.boundary.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.assets.boundary.rst @@ -3,5 +3,5 @@ solver.network.assets.boundary .. automodule:: omotes_simulator_core.solver.network.assets.boundary :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.network.assets.buffer_asset.rst b/doc/developer/api/omotes_simulator_core.solver.network.assets.buffer_asset.rst index 37db7636..727bac0d 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.assets.buffer_asset.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.assets.buffer_asset.rst @@ -3,5 +3,5 @@ solver.network.assets.buffer_asset .. automodule:: omotes_simulator_core.solver.network.assets.buffer_asset :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.network.assets.fall_type.rst b/doc/developer/api/omotes_simulator_core.solver.network.assets.fall_type.rst index 6e84f67d..9886ef76 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.assets.fall_type.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.assets.fall_type.rst @@ -3,5 +3,5 @@ solver.network.assets.fall_type .. automodule:: omotes_simulator_core.solver.network.assets.fall_type :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.network.assets.heat_transfer_asset.rst b/doc/developer/api/omotes_simulator_core.solver.network.assets.heat_transfer_asset.rst index 97ca7a82..db8557fb 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.assets.heat_transfer_asset.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.assets.heat_transfer_asset.rst @@ -3,5 +3,5 @@ solver.network.assets.heat_transfer_asset .. automodule:: omotes_simulator_core.solver.network.assets.heat_transfer_asset :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.network.assets.node.rst b/doc/developer/api/omotes_simulator_core.solver.network.assets.node.rst index 05f24c1c..66122eab 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.assets.node.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.assets.node.rst @@ -3,5 +3,5 @@ solver.network.assets.node .. automodule:: omotes_simulator_core.solver.network.assets.node :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.network.assets.production_asset.rst b/doc/developer/api/omotes_simulator_core.solver.network.assets.production_asset.rst index 6fe926d5..74c6b66b 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.assets.production_asset.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.assets.production_asset.rst @@ -3,5 +3,5 @@ solver.network.assets.production_asset .. automodule:: omotes_simulator_core.solver.network.assets.production_asset :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.network.assets.rst b/doc/developer/api/omotes_simulator_core.solver.network.assets.rst index ccd9bcc7..cd32c42a 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.assets.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.assets.rst @@ -3,8 +3,8 @@ solver.network.assets .. automodule:: omotes_simulator_core.solver.network.assets :members: - :undoc-members: :show-inheritance: + :undoc-members: Submodules ---------- diff --git a/doc/developer/api/omotes_simulator_core.solver.network.assets.solver_pipe.rst b/doc/developer/api/omotes_simulator_core.solver.network.assets.solver_pipe.rst index f769f0f9..36d6fe89 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.assets.solver_pipe.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.assets.solver_pipe.rst @@ -3,5 +3,5 @@ solver.network.assets.solver_pipe .. automodule:: omotes_simulator_core.solver.network.assets.solver_pipe :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.network.network.rst b/doc/developer/api/omotes_simulator_core.solver.network.network.rst index b8c0664c..e3b68646 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.network.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.network.rst @@ -3,5 +3,5 @@ solver.network.network .. automodule:: omotes_simulator_core.solver.network.network :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.network.rst b/doc/developer/api/omotes_simulator_core.solver.network.rst index 747490ef..aac311d4 100644 --- a/doc/developer/api/omotes_simulator_core.solver.network.rst +++ b/doc/developer/api/omotes_simulator_core.solver.network.rst @@ -3,8 +3,8 @@ solver.network .. automodule:: omotes_simulator_core.solver.network :members: - :undoc-members: :show-inheritance: + :undoc-members: Subpackages ----------- diff --git a/doc/developer/api/omotes_simulator_core.solver.rst b/doc/developer/api/omotes_simulator_core.solver.rst index b20e9939..e00f9b2d 100644 --- a/doc/developer/api/omotes_simulator_core.solver.rst +++ b/doc/developer/api/omotes_simulator_core.solver.rst @@ -3,8 +3,8 @@ solver .. automodule:: omotes_simulator_core.solver :members: - :undoc-members: :show-inheritance: + :undoc-members: Subpackages ----------- diff --git a/doc/developer/api/omotes_simulator_core.solver.solver.rst b/doc/developer/api/omotes_simulator_core.solver.solver.rst index 76d6b5af..9e30e1ce 100644 --- a/doc/developer/api/omotes_simulator_core.solver.solver.rst +++ b/doc/developer/api/omotes_simulator_core.solver.solver.rst @@ -3,5 +3,5 @@ solver.solver .. automodule:: omotes_simulator_core.solver.solver :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/developer/api/omotes_simulator_core.solver.solver_constants.rst b/doc/developer/api/omotes_simulator_core.solver.solver_constants.rst index 776696d5..ec94dbd9 100644 --- a/doc/developer/api/omotes_simulator_core.solver.solver_constants.rst +++ b/doc/developer/api/omotes_simulator_core.solver.solver_constants.rst @@ -3,5 +3,5 @@ solver.solver_constants .. automodule:: omotes_simulator_core.solver.solver_constants :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/doc/requirements.txt b/doc/requirements.txt index be7c2b81..e975fbc4 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,5 +1,4 @@ -Sphinx>=4.2.0 -sphinx-rtd-theme>=1.0.0 -sphinxcontrib-bibtex>=2.4.2 -python_docs_theme>=2024.12 -furo>=2024.8.6 \ No newline at end of file +Sphinx~=9.0.4 +sphinx-rtd-theme~=3.1.0 +sphinxcontrib-bibtex~=2.7.0 +furo~=2025.12.19 \ No newline at end of file diff --git a/doc/run_spinx.bat b/doc/run_spinx.bat index 7ec442ef..b47df5d7 100644 --- a/doc/run_spinx.bat +++ b/doc/run_spinx.bat @@ -4,14 +4,11 @@ setlocal rem Jump to the directory where this script is located (doc\) pushd "%~dp0" -set "PY_BOOTSTRAP=python" -where py >NUL 2>NUL if %ERRORLEVEL% EQU 0 set "PY_BOOTSTRAP=py" if not exist .\venv\Scripts\python.exe ( echo Creating virtual environment... - %PY_BOOTSTRAP% -m venv .\venv - + call create_venv.bat call .\venv\Scripts\activate.bat ) else ( echo Using existing virtual environment...