Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +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.
url: https://github.com/NatLabRockies/H2Integrate/discussions
about: Have any questions about using H2Integrate? Post in Discussions to engage with the NLR team and H2Integrate community.
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,11 @@ failing test cases.


<!--
__ For NREL use __
__ For NLR 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
- [ ] Create a tag on the main branch in the NatLabRockies/H2Integrate repository and push
- [ ] Ensure the Test PyPI build is successful
- [ ] Create a release on the main branch
-->
198 changes: 99 additions & 99 deletions CHANGELOG.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# H2Integrate: Holistic Hybrids Optimization and Design Tool

[![PyPI version](https://badge.fury.io/py/H2Integrate.svg)](https://badge.fury.io/py/H2Integrate)
![CI Tests](https://github.com/NREL/H2Integrate/actions/workflows/ci.yml/badge.svg)
![CI Tests](https://github.com/NatLabRockies/H2Integrate/actions/workflows/ci.yml/badge.svg)
[![image](https://img.shields.io/pypi/pyversions/H2Integrate.svg)](https://pypi.python.org/pypi/H2Integrate)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![DOI:10.5281/zenodo.17903150](https://zenodo.org/badge/DOI/10.5281/zenodo.17903149.svg)](https://zenodo.org/records/17903149)
Expand Down Expand Up @@ -113,7 +113,7 @@ pip install h2integrate
1. Using Git, navigate to a local target directory and clone repository:

```bash
git clone https://github.com/NREL/H2Integrate.git
git clone https://github.com/NatLabRockies/H2Integrate.git
```

2. Navigate to `H2Integrate`
Expand Down Expand Up @@ -156,7 +156,7 @@ pip install -e ".[all]"
1. Using Git, navigate to a local target directory and clone repository:

```bash
git clone https://github.com/NREL/H2Integrate.git
git clone https://github.com/NatLabRockies/H2Integrate.git
```

2. Navigate to `H2Integrate`
Expand Down
16 changes: 8 additions & 8 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
We welcome contributions in the form of bug reports, bug fixes, improvements to the documentation,
ideas for enhancements (or the enhancements themselves!).

You can find a [list of current issues](https://github.com/NREL/H2Integrate/issues) in the project's
You can find a [list of current issues](https://github.com/NatLabRockies/H2Integrate/issues) in the project's
GitHub repo. Feel free to tackle any existing bugs or enhancement ideas by submitting a
[pull request](https://github.com/NREL/H2Integrate/pulls).
[pull request](https://github.com/NatLabRockies/H2Integrate/pulls).

## Bug Reports

Expand All @@ -21,7 +21,7 @@ GitHub repo. Feel free to tackle any existing bugs or enhancement ideas by submi
* Docstrings are required and should follow the
[Google style](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html).
* When you start working on a pull request, start by creating a new branch pointing at the latest
commit on [main](https://github.com/NREL/H2Integrate).
commit on [main](https://github.com/NatLabRockies/H2Integrate).
* Code formatting is enforced using pre-commit hooks and is required for any code pushed up to the repository. The pre-commit package is included in the developer install of the repository. The pre-commit hooks can be installed by running
```bash
pre-commit install
Expand All @@ -31,7 +31,7 @@ in the repository directory. This will automatically run the pre-commit formatti
git commit -am "<Your commit message here>"
```
which will re-add the reformatted files to the commit.
* The H2Integrate copyright policy is detailed in the [`LICENSE`](https://github.com/NREL/H2Integrate/blob/main/LICENSE).
* The H2Integrate copyright policy is detailed in the [`LICENSE`](https://github.com/NatLabRockies/H2Integrate/blob/main/LICENSE).

## Documentation

Expand Down Expand Up @@ -89,7 +89,7 @@ pytest tests/h2integrate/test_hybrid.py::test_h2integrate_system
```

When you push to your fork, or open a PR, your tests will be run against the
[Continuous Integration (CI)](https://github.com/NREL/HOPP/actions) suite. This will start a build
[Continuous Integration (CI)](https://github.com/NatLabRockies/HOPP/actions) suite. This will start a build
that runs all tests on your branch against multiple Python versions, and will also test
documentation builds.

Expand Down Expand Up @@ -142,7 +142,7 @@ met the following steps should be taken to create a new release
```

6. Check that the
[Test PyPI GitHub Action](https://github.com/NREL/H2Integrate/actions/workflows/publish_to_test_pypi.yml)
[Test PyPI GitHub Action](https://github.com/NatLabRockies/H2Integrate/actions/workflows/publish_to_test_pypi.yml)
has run successfully.
1. If the action failed, identify and fix the issue, then
2. delete the local and remote tag using the following (replace "v0.1" in all instances just like
Expand All @@ -155,7 +155,7 @@ met the following steps should be taken to create a new release

3. Start back at step 1.
7. When the Test PyPI Action has successfully run,
[create a new release](https://github.com/NREL/H2Integrate/releases/new) using the tag created in
[create a new release](https://github.com/NatLabRockies/H2Integrate/releases/new) using the tag created in
step 5.

### Patches
Expand All @@ -167,4 +167,4 @@ below:
1. All CI tests pass and the patch version has been bumped according to the
[semantic versioning guidelines](https://semver.org/).
2. Follow steps 4 through 7 above.
3. Merge the NREL main branch back into the develop branch and push the changes.
3. Merge the NLR main branch back into the develop branch and push the changes.
29 changes: 1 addition & 28 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ latex:
targetname: book.tex
# Information about where the book exists on the web
repository:
url: https://github.com/NREL/H2Integrate
url: https://github.com/NatLabRockies/H2Integrate
path_to_book: docs
branch: main
# Add GitHub buttons to your book
Expand All @@ -39,33 +39,6 @@ sphinx:
- sphinx.ext.autosummary
- sphinx.ext.napoleon
config:
# html_theme: sphinx_book_theme
# html_theme_options:
# use_issues_button: true
# use_repository_button: true
# use_edit_page_button: true
# show_toc_level: 2
# repository_url: https://github.com/NREL/WAVES
# repository_branch: main
# icon_links: [
# {
# name: GitHub,
# url: https://github.com/NREL/WAVES,
# icon: fa-brands fa-github,
# },
# {
# name: PyPI version,
# url: https://pypi.org/project/WAVES/,
# icon: "https://img.shields.io/pypi/v/WAVES?link=https%3A%2F%2Fpypi.org%2Fproject%2FWAVES%2F",
# type: url,
# },
# {
# name: Binder,
# url: "https://mybinder.org/v2/gh/NREL/WAVES/main?filepath=examples",
# icon: "https://mybinder.org/badge_logo.svg",
# type: url,
# },
# ]
language: python
autosummary_generate: true
autodoc_default_options:
Expand Down
4 changes: 2 additions & 2 deletions docs/developer_guide/why_make_h2integrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Using OpenMDAO for this gives quite a few benefits:
- internal units handling and conversion
- built-in nonlinear solvers to resolve model coupling
- built-in optimization and parameter sweep drivers
- multiple existing NREL tools use OpenMDAO, including [WISDEM](https://github.com/WISDEM/WISDEM/) and [WEIS](https://github.com/WISDEM/WEIS), so we can draw from institutional knowledge
- multiple existing NLR tools use OpenMDAO, including [WISDEM](https://github.com/NLRWindSystems/WISDEM/) and [WEIS](https://github.com/NLRWindSystems/WEIS), so we can draw from institutional knowledge
- set up with gradient-based optimization in mind, which is not currently a focus for H2Integrate but this positions the tool well for potential future additions
- parallelization done using MPI, which is also not currently a focus but useful for the future

Expand All @@ -60,7 +60,7 @@ Additionally, we can code H2Integrate in a way to minimize some of the potential

## Where does HOPP come into play?

[HOPP](https://github.com/NREL/HOPP) is a well-structured and useful tool that analyzes hybrid plants producing electricity.
[HOPP](https://github.com/NatLabRockies/HOPP) is a well-structured and useful tool that analyzes hybrid plants producing electricity.
H2Integrate historically calls HOPP to obtain the plant's outputted electricity, which is then used downstream to feed into electrolyzers, steel, and other components.
The current setup of H2Integrate largely works in the same way.

Expand Down
6 changes: 3 additions & 3 deletions docs/finance_models/ProFastBase.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
(profastmodel:profastmodel)=
# ProFAST Financial Model
The Production Financial Analysis Scenario Tool or (ProFAST)[https://www.nrel.gov/hydrogen/profast-access] is a financial modeling tool developed at the NREL based on General Accepted Accounting Principles (GAAP) methodology. The model provides a quick and convenient way to conduct in-depth financial analysis for production system and services.
The Production Financial Analysis Scenario Tool or (ProFAST)[https://www.nlr.gov/hydrogen/profast-access] is a financial modeling tool developed at the NLR based on General Accepted Accounting Principles (GAAP) methodology. The model provides a quick and convenient way to conduct in-depth financial analysis for production system and services.

Currently there are two ProFAST models that can be used:
- [``ProFastLCO``](profastcomp:profastcompmodel): A price-taker model that calculates levelized cost of commodity (or breakeven price) using [ProFAST](https://github.com/NREL/ProFAST).
- [``ProFastNPV``](profastnpv:profastnpvmodel): A price-setter model that calculates the net present value of a commodity using [ProFAST](https://github.com/NREL/ProFAST).
- [``ProFastLCO``](profastcomp:profastcompmodel): A price-taker model that calculates levelized cost of commodity (or breakeven price) using [ProFAST](https://github.com/NatLabRockies/ProFAST).
- [``ProFastNPV``](profastnpv:profastnpvmodel): A price-setter model that calculates the net present value of a commodity using [ProFAST](https://github.com/NatLabRockies/ProFAST).

(profast:overview)=
## Finance parameters overview
Expand Down
2 changes: 1 addition & 1 deletion docs/finance_models/ProFastComp.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

(profastcomp:profastcompmodel)=
# ProFastComp
The `ProFastLCO` finance model calculates levelized cost of a commodity using [ProFAST](https://github.com/NREL/ProFAST).
The `ProFastLCO` finance model calculates levelized cost of a commodity using [ProFAST](https://github.com/NatLabRockies/ProFAST).

The inputs, outputs, and naming convention for the `ProFastLCO` model are outlined in this doc page.

Expand Down
2 changes: 1 addition & 1 deletion docs/finance_models/ProFastNPV.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
(profastnpv:profastnpvmodel)=
# ProFastNPV
The `ProFastNPV` finance model calculates the net present value (NPV) of a commodity using [ProFAST](https://github.com/NREL/ProFAST).
The `ProFastNPV` finance model calculates the net present value (NPV) of a commodity using [ProFAST](https://github.com/NatLabRockies/ProFAST).

`ProFastNPV` inherits from `ProFastBase` so refer to the [`ProFastBase` documentation](profast:overview) for setting the finance parameters.

Expand Down
6 changes: 3 additions & 3 deletions docs/finance_models/finance_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ The `commodity_type` and `description` are used in the finance model naming conv
(finance:supportedmodels)=
## Currently supported general finance models

- [``ProFastLCO``](profastcomp:profastcompmodel): calculates levelized cost of commodity using [ProFAST](https://github.com/NREL/ProFAST).
- [``ProFastNPV``](profastnpv:profastnpvmodel): calculates the net present value of a commodity using [ProFAST](https://github.com/NREL/ProFAST).
- [``ProFastLCO``](profastcomp:profastcompmodel): calculates levelized cost of commodity using [ProFAST](https://github.com/NatLabRockies/ProFAST).
- [``ProFastNPV``](profastnpv:profastnpvmodel): calculates the net present value of a commodity using [ProFAST](https://github.com/NatLabRockies/ProFAST).
- [``NumpyFinancialNPV``](numpyfinancialnpvfinance:numpyfinancialnpvmodel): calculates the net present value of a commodity using the [NumPy Financial npv](https://numpy.org/numpy-financial/latest/npv.html#numpy_financial.npv) method.

## Custom finance models

A general finance model can be defined similarly to a custom technology model. A custom finance model should be defined in the plant configuration file within the `finance_groups` section under `finance_parameters`.

Below shows an example, similar to the [Wind Electrolyzer Example](https://github.com/NREL/H2Integrate/tree/develop/examples/08_wind_electrolyzer/) of how to define a custom finance model within the `plant_config.yaml` file:
Below shows an example, similar to the [Wind Electrolyzer Example](https://github.com/NatLabRockies/H2Integrate/tree/develop/examples/08_wind_electrolyzer/) of how to define a custom finance model within the `plant_config.yaml` file:
```yaml
finance_parameters:
finance_groups:
Expand Down
4 changes: 2 additions & 2 deletions docs/getting_started/expected_user_knowledge.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ Users should also be familiar with the [Google style](https://www.sphinx-doc.org
H2Integrate itself is a framework that relies on a number of other tools and libraries to function.
Users should be familiar with the following tools and libraries to use H2Integrate effectively:

- [HOPP](https://github.com/NREL/HOPP): Used for simulating technologies that produce electricity for other components in H2Integrate
- [PySAM](https://github.com/NREL/pysam): Provides access to the System Advisor Model (SAM) for performance and financial modeling; underlying tool used for modeling certain generation technologies
- [HOPP](https://github.com/NatLabRockies/HOPP): Used for simulating technologies that produce electricity for other components in H2Integrate
- [PySAM](https://github.com/NatLabRockies/pysam): Provides access to the System Advisor Model (SAM) for performance and financial modeling; underlying tool used for modeling certain generation technologies
- [OpenMDAO](https://openmdao.org/): A framework for multidisciplinary optimization, analysis, and design; used for data-passing, model organization, and optimization
- [Pyomo](http://www.pyomo.org/): A Python-based, open-source optimization modeling language; only useful to understand if you are modifying the dispatch algorithms
- [Pandas](https://pandas.pydata.org/): A data manipulation and analysis library used for handling and analyzing data structures; useful for post-processing results
8 changes: 4 additions & 4 deletions docs/getting_started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ pip install h2integrate

If you want to develop new models or contribute to H2Integrate, you can install it from source.

### NREL Resource Data
### NLR Resource Data

1. The functions which download resource data require an NLR API key. Obtain a key from:

Expand All @@ -29,12 +29,12 @@ If you want to develop new models or contribute to H2Integrate, you can install
NLR_API_EMAIL=your.name@email.com
```

### NREL-Provided Conda Environment Specification (recommended)
### NLR-Provided Conda Environment Specification (recommended)

1. Using Git, navigate to a local target directory and clone repository:

```bash
git clone https://github.com/NREL/H2Integrate.git
git clone https://github.com/NatLabRockies/H2Integrate.git
```

2. Navigate to `H2Integrate`
Expand Down Expand Up @@ -90,7 +90,7 @@ pip install -e ".[all]"
1. Using Git, navigate to a local target directory and clone repository:

```bash
git clone https://github.com/NREL/H2Integrate.git
git clone https://github.com/NatLabRockies/H2Integrate.git
```

2. Navigate to `H2Integrate`
Expand Down
Loading
Loading