Tech and system model figures#554
Tech and system model figures#554jaredthomas68 wants to merge 7 commits intoNatLabRockies:developfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds two new diagram figures (tech-model.png and system-model.png) to the documentation and updates the intro.md file to incorporate these visual aids. The changes aim to provide better insight into how H2Integrate's technology and system models are structured.
Changes:
- Added visual representations of individual technology models and system-level models
- Reorganized the "How does H2Integrate work?" section to incorporate the new diagrams
- Enhanced explanations of how technology models connect to form hybrid system models
Reviewed changes
Copilot reviewed 1 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/system-model.png | New diagram showing a simplistic example of how technology models connect in an H2Integrate system |
| docs/tech-model.png | New diagram showing the structure of a single technology model with control, performance, cost, and finance components |
| docs/intro.md | Updated documentation text to reference new diagrams and improve explanation of H2Integrate's modeling approach |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/intro.md
Outdated
|  | ||
|
|
||
| This process is shown for an example energy system in the figure below: | ||
| If technologies require resource or price profiles, they can be provided by the user, or in many cases pulled automatically from existing databases. The costs and performance of the technology models in the system are combined for the system performance and system finance components for techno-economic analysis of the hybrid system. H2Integrate systems may include multiple system-level finance models to asses results with different system boundaries if desired. Besides simulation and analysis, H2Integrate can also perform system and sub-system optimization. |
There was a problem hiding this comment.
Spelling error: "asses" should be "assess". The word "asses" refers to donkeys, while "assess" means to evaluate or analyze.
| If technologies require resource or price profiles, they can be provided by the user, or in many cases pulled automatically from existing databases. The costs and performance of the technology models in the system are combined for the system performance and system finance components for techno-economic analysis of the hybrid system. H2Integrate systems may include multiple system-level finance models to asses results with different system boundaries if desired. Besides simulation and analysis, H2Integrate can also perform system and sub-system optimization. | |
| If technologies require resource or price profiles, they can be provided by the user, or in many cases pulled automatically from existing databases. The costs and performance of the technology models in the system are combined for the system performance and system finance components for techno-economic analysis of the hybrid system. H2Integrate systems may include multiple system-level finance models to assess results with different system boundaries if desired. Besides simulation and analysis, H2Integrate can also perform system and sub-system optimization. |
| Additionally, H2Integrate tracks the flow of electricity, molecules (e.g., hydrogen, ammonia, methanol), and other products (e.g., steel) between different technologies in the energy system. | ||
|
|
||
| H2Integrate uses a set of models to simulate the control, performance, cost, and finance of each technology, where only the performance and cost are required for most technologies. | ||
|  |
There was a problem hiding this comment.
For consistency with the existing image reference on line 81, consider adding the "./" prefix to the image path. The splash_image.png reference uses "./splash_image.png" while this new reference uses "tech-model.png" without the prefix. While both may work, consistency in image path formatting improves maintainability.
| - Modeling the performance of hydrogen electrolyzers, steel furnaces, methanol plants, or ammonia synthesis systems using the generated electricity profiles | ||
| - Performing techno-economic analysis of the system to evaluate its costs and financial viability | ||
| The individual technology models are then connected to create the hybrid system model, as shown in the simplistic example below. | ||
|  |
There was a problem hiding this comment.
For consistency with the existing image reference on line 81, consider adding the "./" prefix to the image path. The splash_image.png reference uses "./splash_image.png" while this new reference uses "system-model.png" without the prefix. While both may work, consistency in image path formatting improves maintainability.
|  | |
|  |
docs/intro.md
Outdated
|  | ||
|
|
||
| This process is shown for an example energy system in the figure below: | ||
| If technologies require resource or price profiles, they can be provided by the user, or in many cases pulled automatically from existing databases. The costs and performance of the technology models in the system are combined for the system performance and system finance components for techno-economic analysis of the hybrid system. H2Integrate systems may include multiple system-level finance models to asses results with different system boundaries if desired. Besides simulation and analysis, H2Integrate can also perform system and sub-system optimization. |
There was a problem hiding this comment.
This sentence is quite long (67 words) and covers multiple distinct concepts. Consider breaking it into 2-3 shorter sentences for improved readability. For example: "If technologies require resource or price profiles, they can be provided by the user, or in many cases pulled automatically from existing databases. The costs and performance of the technology models in the system are combined for the system performance and system finance components for techno-economic analysis of the hybrid system. H2Integrate systems may include multiple system-level finance models to assess results with different system boundaries if desired."
| If technologies require resource or price profiles, they can be provided by the user, or in many cases pulled automatically from existing databases. The costs and performance of the technology models in the system are combined for the system performance and system finance components for techno-economic analysis of the hybrid system. H2Integrate systems may include multiple system-level finance models to asses results with different system boundaries if desired. Besides simulation and analysis, H2Integrate can also perform system and sub-system optimization. | |
| If technologies require resource or price profiles, they can be provided by the user. In many cases, these profiles can also be pulled automatically from existing databases. The costs and performance of the technology models in the system are combined in the system performance and system finance components to support techno-economic analysis of the hybrid system. H2Integrate systems may include multiple system-level finance models to assess results with different system boundaries, if desired. Besides simulation and analysis, H2Integrate can also perform system and subsystem optimization. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
bayc
left a comment
bayc
left a comment
There was a problem hiding this comment.
Hey @jaredthomas68 , thanks for adding these graphics and descriptions, super helpful! I've suggested some added text to hopefully give more detail for the users, let me know what you think.
Co-authored-by: Chris Bay <12664940+bayc@users.noreply.github.com>
Co-authored-by: Chris Bay <12664940+bayc@users.noreply.github.com>
Co-authored-by: Chris Bay <12664940+bayc@users.noreply.github.com>
genevievestarke
left a comment
genevievestarke
left a comment
There was a problem hiding this comment.
Thanks for making these @jaredthomas68, they're really great for introducing the structure of H2I! I have a non-blocking comment on one of the figures :)
There was a problem hiding this comment.
The main comment I have here is that by separating out steel, it looks like that is separate from the ammonia, methanol, etc. end uses. Is the steel modeling different materially, or do we just have more detail there?
There was a problem hiding this comment.
I separated steel out and not ammonia because we have more technologies that are specifically related to the steel supply chain. I debated just leaving the tech lists out of the figures, but I think it does help.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 3 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Depending on the models used and the size of the system, H2Integrate can simulate systems ranging from the kW to GW scale in seconds on a personal computer. | ||
| Additionally, H2Integrate tracks the flow of electricity, molecules (e.g., hydrogen, ammonia, methanol), and other products (e.g., steel) between different technologies in the energy system. | ||
|
|
||
| For each technology there are 4 different types of models: control, performance, cost, and finance. These model categories allow for modular pieces to be brought in or re-used throughout H2Integrate, as well as ease of development and organization. Note that the only required models for a technology are performance and cost, while control and finance are optional. The figure below shows these four categories and some of the technologies included in H2Integrate. For a full list of models available, please see [Model Overview](user_guide/model_overview.md). |
There was a problem hiding this comment.
There’s an extra space in “ease of” that should be removed to avoid rendering/editing artifacts.
| For each technology there are 4 different types of models: control, performance, cost, and finance. These model categories allow for modular pieces to be brought in or re-used throughout H2Integrate, as well as ease of development and organization. Note that the only required models for a technology are performance and cost, while control and finance are optional. The figure below shows these four categories and some of the technologies included in H2Integrate. For a full list of models available, please see [Model Overview](user_guide/model_overview.md). | |
| For each technology there are 4 different types of models: control, performance, cost, and finance. These model categories allow for modular pieces to be brought in or re-used throughout H2Integrate, as well as ease of development and organization. Note that the only required models for a technology are performance and cost, while control and finance are optional. The figure below shows these four categories and some of the technologies included in H2Integrate. For a full list of models available, please see [Model Overview](user_guide/model_overview.md). |
|  | ||
|
|
||
| H2Integrate models hybrid energy systems by: | ||
| - Generating electricity output profiles from renewable energy sources (e.g., wind, solar, hydro) and storage systems (e.g., batteries, pumped hydro, vanadium flow batteries) | ||
| - Modeling the performance of hydrogen electrolyzers, steel furnaces, methanol plants, or ammonia synthesis systems using the generated electricity profiles | ||
| - Performing techno-economic analysis of the system to evaluate its costs and financial viability | ||
| The individual technology models are then connected to create the hybrid system model, as shown in the simplistic example below. Here, data from the performance, cost, and finance models of the grid and battery technologies feed into the overall system performance and finance calculations. There is also a physical connection between the grid and battery performance models in the form of an electrical cable. Lastly, within the battery technology, the control model and performance models are connected for dispatching of electricity. | ||
|  |
There was a problem hiding this comment.
Image links use mixed relative-path styles (tech-model.png vs ./splash_image.png). For consistency (and to reduce ambiguity across doc build tooling), consider standardizing on one form (e.g., prefixing all local images with ./).
| If technologies require resource or price profiles, they can be provided by the user, or in many cases pulled automatically from existing databases. The costs and performance of the technology models in the system are combined into system-level performance and finance components for techno-economic analysis of the hybrid system. H2Integrate systems may include multiple system-level finance models to assess results with different system boundaries if desired. Besides simulation and analysis, H2Integrate can also perform system and sub-system optimization. | ||
|
|
||
| A more complex and generalized example of an H2Integrate model is shown below: | ||
|  |
There was a problem hiding this comment.
Image links use mixed relative-path styles (tech-model.png vs ./splash_image.png). For consistency (and to reduce ambiguity across doc build tooling), consider standardizing on one form (e.g., prefixing all local images with ./).
Trying to provide more insight in the docs about how H2I is set up.
This PR adds some figures to show users how H2I systems connect together. I think it is very important for users to understand this up front since H2I is primarily an integrator of other sub-system models.
Section 1: Type of Contribution
Section 2: Draft PR Checklist
TODO:
Type of Reviewer Feedback Requested (on Draft PR)
Structural feedback:
Implementation feedback:
Other feedback:
I'm looking for general response to the clarity and design of the figures, as well as there location in the docs. I plan to revise the text, but any feedback there is also of interest.
Section 3: General PR Checklist
docs/files are up-to-date, or added when necessaryCHANGELOG.mdhas been updated to describe the changes made in this PRSection 3: Related Issues
Section 4: Impacted Areas of the Software
Section 4.1: New Files
path/to/file.extensionmethod1: What and why something was changed in one sentence or less.Section 4.2: Modified Files
path/to/file.extensionmethod1: What and why something was changed in one sentence or less.Section 5: Additional Supporting Information
Section 6: Test Results, if applicable
Section 7 (Optional): New Model Checklist
docs/developer_guide/coding_guidelines.mdattrsclass to define theConfigto load in attributes for the modelBaseConfigorCostModelBaseConfiginitialize()method,setup()method,compute()methodCostModelBaseClasssupported_models.pycreate_financial_modelinh2integrate_model.pytest_all_examples.pydocs/user_guide/model_overview.mddocs/section<model_name>.mdis added to the_toc.yml