h2integrate 0.2__tar.gz

h2integrate-0.2/.git-blame-ignore-revs

@@ -0,0 +1,10 @@
+# Migrate code style to Ruff linting and formatting
+5010f84683f4e8c46c562c5f9cd9c17cc1459c1f
+1c9b986be16d87df1b8b0e351c9b839b6a3d8aed
+6208b1fcdafb48b11048dac173813d80bba6c9d9
+b7ffc2b8e4a821680ce354e59c7362db8aa53197
+1ebbf6b32435bff565b628cde2a28c599a1a99ef
+ce9f96cd49ff9dbbcf75c3a32ff300515c9fa593
+3e8d3abd343569833ece0ab4f4048a4bf43d0a94
+9f3f5c14e406aca284d01d6dd3b9c89e3c439acb
+36d49ab2c959ff26736c5ee01f5bcc8fd11ec24e

h2integrate-0.2/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,77 @@
+---
+name: Bug report
+about: Report a bug to help us improve
+title: 'Bug report'
+labels: "Type: Bug"
+---
+
+<!--
+Thank you for taking the time to report a bug. If you aren't certain whether an issue
+is a bug, please first open a Discussion. Before submitting, please reread your
+description to ensure that other readers can reasonably understand the issue
+you're facing and the impact on your workflow or results.
+
+IMPORTANT NOTES
+
+1. Replace all example text (contained in "<>") or anywhere specifically commenting to replace the
+   text, leaving any guiding HTML comments in place (formatted like this large block so it won't
+   show up in your Bug Report text.)
+2. Use GH flavored markdown: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax,
+   especially for code snippets, which should look like the following:
+   ```python
+   a = 1
+   b = 2
+   print(a + b)
+   ```
+3. Please be as thorough as possible when describing what went wrong, and what was expected from a
+   correct solution. The amount of information required to describe the bug may differ, but more
+   information is always helpful to ensure you receive the help you need.
+-->
+
+<!--The title should clearly define the issue succinctly.-->
+# Add meaningful title here
+
+<!-- Describe your bug/issue here using as much detail as necessary. -->
+
+
+## How to reproduce
+
+<!-- Describe how another person with no context can recreate this issue. -->
+
+
+## Relevant output
+
+<!-- Include any output, plots, tracebacks, or other means of communication here to add context to
+the problem. All code and full tracebacks should be properly markdown formatted. -->
+
+
+## System Information
+<!-- Add your information here. -->
+- OS: <macOS 12.4>
+  <!-- e.g. Ubuntu 20.04 or macOS 10.12 -->
+- Python version: <3.10.4>
+  <!-- All OS: `python --version`-->
+- H2Integrate version: <0.1.1>
+  <!--
+  Unix: pip freeze | grep h2integrate | awk -F"git@" '/git@/{print $2}' | awk -F"#egg" '/#egg/{print $1}'
+  Windows: `pip list --format freeze | findstr h2integrate`
+  -->
+  - <Installed from source using an editable installation with developer tools: `pip install -e .[develop]`>
+  - Commit hash: <commit-hash>
+    <!--
+    Unix: `pip freeze | grep h2integrate | awk -F"git@" '/git@/{print $2}' | awk -F"#egg" '/#egg/{print $1}'`
+    Windows: `pip freeze | findstr h2integrate`, then copy the full git hash between "git@" and "#egg"
+    -->
+
+### Relevant library versions
+<!--
+Use `pip freeze` to gather the relevant versions, and use the markdown table formatting as
+demonstrated below to replacing all relevant packages and their versions.
+-->
+  | Package | Version |
+  | ------- | ------- |
+  | hopp | <3.1.1> |
+  | numpy | <1.26.4> |
+  | Pyomo | <6.8.0> |
+  | scipy | <1.14.1> |
+  | <another-relevant-package> | <version> |

h2integrate-0.2/.github/ISSUE_TEMPLATE/config.yaml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Usage question
+    url: https://github.com/NREL/H2Integrate/discussions
+    about: Have any questions about using H2Integrate? Post in Discussions to engage with the NREL team and H2Integrate community.

h2integrate-0.2/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,46 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: 'Feature request'
+labels: 'Type: Enhancement'
+---
+
+<!--
+Thank you for taking the time to suggest a feature. Before submitting,
+please reread your description to ensure that other readers can reasonably
+understand the motivation and proposed solution.
+
+IMPORTANT NOTES
+
+1. Leave all HTML comments in place (formatted like this large block so it won't show up in
+   your Feature Request text.)
+2. Use GH flavored markdown: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax,
+   especially for code snippets, which should look like the following:
+   ```python
+   a = 1
+   b = 2
+   print(a + b)
+   ```
+3. Please be as thorough as possible when describing what the proposed enhancement or feature should
+   do, including any finer details to guide implementation.
+-->
+
+<!--The title should clearly define the feature request/enhancement succinctly.-->
+# Add meaningful title here
+
+<!-- Describe the desired enhancement. -->
+
+
+## Proposed solution
+
+<!-- Please include pseudocode (markdown-formatted), images, or any other visual aids to communicate the idea. -->
+
+
+## Alternatives considered
+
+<!-- Describe workarounds or alternatives even if hacky or incomplete. Sometimes these are the best solution! -->
+
+
+## Additional context
+
+<!-- Provide anything else that helps to communicate the idea here. -->

h2integrate-0.2/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,78 @@
+
+<!--
+IMPORTANT NOTES
+
+1. Use GH flavored markdown when writing your description:
+   https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
+
+2. If all boxes in the PR Checklist cannot be checked, this PR should be marked as a draft.
+
+3. DO NOT DELTE ANYTHING FROM THIS TEMPLATE. If a section does not apply to you, simply write
+   "N/A" in the description.
+
+4. Code snippets to highlight new, modified, or problematic functionality are highly encouraged,
+   though not required. Be sure to use proper code higlighting as demonstrated below.
+
+   ```python
+    def a_func():
+        return 1
+
+    a = 1
+    b = a_func()
+    print(a + b)
+    ```
+-->
+
+<!--The title should clearly define your contribution succinctly.-->
+# Add meaningful title here
+
+<!-- Describe your feature here. Please include any code snippets or examples in this section. -->
+
+
+## PR Checklist
+
+<!--Tick these boxes if they are complete, or format them as "[x]" for the markdown to render. -->
+- [ ] `CHANGELOG.md` has been updated to describe the changes made in this PR
+- [ ] Documentation
+  - [ ] Docstrings are up-to-date
+  - [ ] Related `docs/` files are up-to-date, or added when necessary
+  - [ ] Documentation has been rebuilt successfully
+  - [ ] Examples have been updated
+- [ ] Tests pass (If not, and this is expected, please elaborate in the tests section)
+- [ ] PR description thoroughly describes the new feature, bug fix, etc.
+
+## Related issues
+
+<!--If one exists, link to a related GitHub Issue.-->
+
+
+## Impacted areas of the software
+
+<!--
+Replace the below example with any added or modified files, and briefly describe what has been changed or added, and why.
+-->
+- `path/to/file.extension`
+  - `method1`: What and why something was changed in one sentence or less.
+
+## Additional supporting information
+
+<!--Add any other context about the problem here.-->
+
+
+## Test results, if applicable
+
+<!--
+Add the results from unit tests and regression tests here along with justification for any
+failing test cases.
+-->
+
+
+<!--
+__ For NREL use __
+Release checklist:
+- [ ] Update the version in h2integrate/__init__.py
+- [ ] Verify docs builds correctly
+- [ ] Create a tag on the main branch in the NREL/H2Integrate repository and push
+- [ ] Ensure the Test PyPI build is successful
+- [ ] Create a release on the main branch
+-->

h2integrate-0.2/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: Testing
+
+on: [ push, pull_request ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        env:
+          SKLEARN_ALLOW_DEPRECATED_SKLEARN_PACKAGE_INSTALL: True
+        run: |
+          sudo apt-get update && sudo apt-get install -y libglpk-dev glpk-utils coinor-cbc
+          python -m pip install --upgrade pip
+          pip install git+https://github.com/NREL/HOPP@develop
+          pip install ".[develop]"
+      - name: Create env file
+        run: |
+          touch .env
+      #     echo NREL_API_KEY=${{ secrets.NREL_API_KEY }} >> .env
+      #     cat .env
+      - name: Run tests
+        run: |
+          PYTHONPATH=. pytest tests
+      - name: Lint with flake8
+        run: |
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          pip install flake8
+          flake8 . --count --exit-zero --statistics --ignore=E501

h2integrate-0.2/.github/workflows/ci_docs.yml

@@ -0,0 +1,21 @@
+name: Test Documentation Build
+
+on: [ push, pull_request ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: |
+          pip install git+https://github.com/NREL/HOPP@develop
+          pip install ".[develop]"
+      - name: Build documentation
+        run: |
+          jupyter-book build docs/

h2integrate-0.2/.github/workflows/gh_pages.yml

@@ -0,0 +1,52 @@
+name: deploy-book
+
+# Run this when the master or main branch changes
+on:
+  push:
+    branches:
+    - main
+
+jobs:
+  deploy-book:
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.11
+
+    - name: Install dependencies
+      run: |
+        pip install git+https://github.com/NREL/HOPP@develop
+        pip install -e ".[develop]"
+
+    # (optional) Cache your executed notebooks between runs
+    # if you have config:
+    # execute:
+    #   execute_notebooks: cache
+    # - name: cache executed notebooks
+    #   uses: actions/cache@v3
+    #   with:
+    #     path: _build/.jupyter_cache
+    #     key: jupyter-book-cache-${{ hashFiles('requirements.txt') }}
+
+    # Build the book
+    - name: Build the book
+      run: |
+        jupyter-book build docs/
+
+    # Upload the book's HTML as an artifact
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: "docs/_build/html"
+
+    # Deploy the book's HTML to GitHub Pages
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

h2integrate-0.2/.github/workflows/pre-commit.yml

@@ -0,0 +1,18 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.9
+    - name: Run pre-commit
+      uses: pre-commit/action@v3.0.1

h2integrate-0.2/.github/workflows/publish_to_pypi.yml

@@ -0,0 +1,31 @@
+name: Upload to PyPi
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    if: github.event.action == 'published'
+    environment:
+      name: pypi-publishing
+      url: https://pypi.org/p/h2integrate
+    permissions:
+      id-token: write
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.9
+    - name: Build package
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools build wheel twine
+        python -m build
+        twine check --strict dist/*
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        verbose: True

h2integrate-0.2/.github/workflows/publish_to_test_pypi.yml

@@ -0,0 +1,33 @@
+name: Upload to Test PyPi
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    environment:
+      name: pypi-publishing
+      url: https://test.pypi.org/p/h2integrate
+    permissions:
+      id-token: write
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.9
+    - name: Build package
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools build wheel twine
+        python -m build
+        twine check --strict dist/*
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        verbose: True
+        repository-url: https://test.pypi.org/legacy/

h2integrate-0.2/.gitignore

@@ -0,0 +1,132 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Python template
+# Byte-compiled / optimized / DLL files
+*__pycache__/*
+*.py[cod]
+*$py.class
+*.pyc
+
+log/
+# needed for h2 test inputs: tests/analysis/results/
+*_disp.txt
+
+.idea/*
+.idea/workspace.xml
+.vscode/
+
+.vscode/*
+
+# Distribution / packaging
+.Python
+env*/*
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+.envrc
+
+# virtualenv
+.venv/
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# Resource data
+#resource_files/solar/*.csv
+#resource_files/wind/*.srw
+
+# Images, datafiles
+*.png
+*.xlsx
+
+*.pkl
+.DS_Store
+*.val
+*.db
+*.db-shm
+*.gz
+*.db-wal
+
+# H2Integrate structure specific
+tests/h2integrate/data/*
+tests/h2integrate/output.txt
+tests/h2integrate/test_hydrogen/data/*
+tests/h2integrate/test_hydrogen/output.txt
+*speed_dir_data.csv
+examples/h2integrate/*/data
+examples/h2integrate/*/figures
+tests/h2integrate/reports/
+tests/h2integrate/test_hydrogen/output/
+
+output*
+snopt_history.txt
+reports/*

h2integrate-0.2/.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+default_language_version:
+    python: python3
+repos:
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+  hooks:
+  - id: isort
+    name: isort
+    stages: [pre-commit]
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-executables-have-shebangs
+  - id: check-json
+  - id: check-yaml
+    args: [--unsafe]  # allow Python constructors
+  - id: check-merge-conflict
+  - id: check-symlinks
+  - id: mixed-line-ending
+  - id: pretty-format-json
+    args: [--autofix]
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.8.1
+  hooks:
+    - id: ruff-format
+      types_or: [ python, pyi, jupyter ]
+    - id: ruff
+      types_or: [ python, pyi, jupyter ]
+      args: [ --fix, --unsafe-fixes]

h2integrate-0.2/CHANGELOG.md

@@ -0,0 +1,59 @@
+# CHANGELOG
+
+## 0.2 [7 April 2025]
+
+- Allow users to save the H2IntegrateOutput class as a yaml file and read that yaml to an instance of the output class
+- Include new plotting capabilities: (1) hydrogen storage, production, and dispatch; (2) electricity and hydrogen dispatch
+- Remove reference_plants from examples. Reference plants can now be found in the [ReferenceHybridSystemDesigns](https://github.com/NREL/ReferenceHybridSystemDesigns) repository.
+- Use sentence capitalization for plot labels and legends
+- Use "metric ton" instead of "tonne" or "metric tonne" in all internal naming and plots
+- Fix bug in hydrogen dispatch plotting by storing time series of hydrogen demand by hour
+- Update the PEM efficiency to 51.0 kWh/kg from 54.6 kWh/kg
+- Bumped PySAM version to 6+ and HOPP to 3.2.0
+- Removed defunct conda build and upload scripts
+- Return full solution dictionary from ProFAST, allowing access to CRF and WACC
+- Renamed code from GreenHEART to H2Integrate
+- Added iron processing framework and capabilities [PR 90](https://github.com/NREL/H2Integrate/pull/90)
+- Added Martin and Rosner iron ore models, performance and cost for each [PR 90](https://github.com/NREL/H2Integrate/pull/90)
+- Added Rosner direct reduction iron (DRI) model, performance and cost [PR 90](https://github.com/NREL/H2Integrate/pull/90)
+- Added Martin transport module for performance and cost of iron [PR 90](https://github.com/NREL/H2Integrate/pull/90)
+- Added generalized Stinn cost model for electrolysis of arbitrary materials [PR 90](https://github.com/NREL/H2Integrate/pull/90)
+
+## v0.1.4 [4 February 2025]
+
+- Adds `CoolProp` to `pyproject.toml`
+- Changes units of `lcoe_real` in `HOPPComponent` from "MW*h" to "kW*h"
+- Adds `pre-commit`, `ruff`, and `isort` checks, and CI workflow to ensure these steps aren't
+  skipped.
+- Updates steel cost year to 2022
+- Updates ammonia cost year to 2022
+- Requires HOPP 3.1.1 or higher
+- Updates tests to be compatible with HOPP 3.1.1 with ProFAST integration
+- Removes support for python 3.9
+- Add steel feedstock transport costs (lime, carbon, and iron ore pellets)
+- Allow individual debt rate, equity rate, and debt/equity ratio/split for each subsystem
+- Add initial docs focused on new H2Integrate development
+- New documentation CI pipeline to publish documentation at nrel.github.io/H2Integrate/ and test
+  that the documentation site will build on each pull request.
+- Placeholder documentation content has been removed from the site build
+
+## v0.1.3 [1 November 2024]
+
+- Replaces the git ProFAST installation with a PyPI installation.
+- Removed dependence on external electrolyzer repo
+- Updated CI to use conda environments with reproducible environment artifacts
+- Rename logger from "wisdem/weis" to "h2integrate"
+- Remove unsupported optimization algorithms
+
+## v0.1.2 [28 October 2024]
+
+- Minor updates to examples for NAWEA workshop.
+- Adds `environment.yml` for easy environment creation and H2Integrate installation.
+
+## v0.1.1 [22 October 2024]
+
+- ?
+
+## v0.1 [16 October 2024]
+
+- Project has been separated from HOPP and moved into H2Integrate, removing all HOPP infrastructure.

h2integrate-0.2/LICENSE

@@ -0,0 +1,31 @@
+**Note: The ProFAST model is distributed with H2Integrate but operates under a separate license agreement. Users must agree to the license terms of ProFAST located at `ProFAST/InternalUseTermsForDownloadableSoftware-ProFAST.docx`.**
+
+BSD 3-Clause License
+
+Copyright (c) 2024, Alliance for Sustainable Energy, LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.