Metadata-Version: 2.4
Name: h2integrate
Version: 0.8.0
Summary: Holistic Hybrids Optimization and Design Tool
Author: Kaitlin Brunik, Elenya Grant, Jared Thomas, Genevieve Starke, Jonathan Martin, Dakota Ramos, Mariya Koleva, Evan Reznicek, Rob Hammond, Brooke Stanislawski, Charlie Kiefer, Cameron Irmas, Sanjana Vijayshankar, Nicholas Riccobono, Cory Frontin, Caitlyn Clark, Aaron Barker, Abhineet Gupta, Benjamin Kee, Jennifer King
Maintainer-email: John Jasa <john.jasa@nlr.gov>, Christopher Bay <christopher.bay@nlr.gov>
License: 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.
        
Project-URL: source, https://github.com/NatLabRockies/H2Integrate
Project-URL: documentation, https://h2integrate.readthedocs.io/
Project-URL: issues, https://github.com/NatLabRockies/H2Integrate/issues
Project-URL: changelog, https://github.com/NatLabRockies/H2Integrate/blob/main/CHANGELOG.md
Keywords: python3,hybrid-energy,wind-energy,solar-energy,layout-optimization
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: <3.14,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: attrs
Requires-Dist: CoolProp<7.0.0
Requires-Dist: geopy
Requires-Dist: jsonschema
Requires-Dist: marine-carbon-management
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: numpy-financial
Requires-Dist: openmdao
Requires-Dist: openmeteo-requests
Requires-Dist: pandas>=2.0.3
Requires-Dist: ProFAST
Requires-Dist: Pyomo>=6.1.2
Requires-Dist: rainflow
Requires-Dist: requests-cache
Requires-Dist: retry_requests
Requires-Dist: rich>=13.7.0
Requires-Dist: ruamel.yaml
Requires-Dist: scipy
Requires-Dist: orbit-nrel
Requires-Dist: floris
Requires-Dist: hopp>=3.3.0
Requires-Dist: turbine-models>=0.2.1
Requires-Dist: wombat>=0.13.3
Provides-Extra: develop
Requires-Dist: isort; extra == "develop"
Requires-Dist: jupyter-book<2; extra == "develop"
Requires-Dist: networkx; extra == "develop"
Requires-Dist: pre-commit; extra == "develop"
Requires-Dist: pyvis; extra == "develop"
Requires-Dist: pytest>=9; extra == "develop"
Requires-Dist: pytest-cov; extra == "develop"
Requires-Dist: ruff; extra == "develop"
Requires-Dist: sphinxcontrib-napoleon; extra == "develop"
Requires-Dist: yamlfix; extra == "develop"
Provides-Extra: examples
Requires-Dist: jupyterlab; extra == "examples"
Requires-Dist: h2integrate[ard,gis]; extra == "examples"
Provides-Extra: gis
Requires-Dist: geopandas; extra == "gis"
Requires-Dist: contextily; extra == "gis"
Provides-Extra: ard
Requires-Dist: ard-nrel; extra == "ard"
Provides-Extra: extras
Requires-Dist: h2integrate[ard,gis]; extra == "extras"
Provides-Extra: all
Requires-Dist: h2integrate[develop,examples,extras]; extra == "all"
Dynamic: license-file

# 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/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.17903150.svg)](https://zenodo.org/records/17903150)

H2Integrate (H2I) is an open-source Python package for hybrid energy systems engineering design and technoeconomic analysis.
It models hybrid systems, especially hybrid energy plants that produce electricity, hydrogen, ammonia, steel, and other products, to perform optimization and scenario analysis.

## Installation

The recommended installation method is via pip from PyPI, which will install the latest stable release of H2Integrate and its dependencies:

```bash
pip install h2integrate
```

For installing from source, development setup, and additional installation options, see the [full installation instructions](https://h2integrate.readthedocs.io/en/latest/getting_started/install.html).

## What H2Integrate Does

H2Integrate is both a **hybrid systems engineering design tool** and a **technoeconomic analysis (TEA) tool**. It significantly expands beyond generalized tools by offering:

- **Detailed equipment-level modeling** with a wide range of subsystem variation options
- **High-resolution, location-specific resource data** for site-dependent performance modeling
- **Cost inputs settable by the user** with examples based on the [Annual Technology Baseline (ATB)](https://atb.nlr.gov/)
- **Optimization and scenario analysis** to explore design trade-offs across hybrid plant configurations

### Available Technologies

H2I includes models for a broad set of energy generation, conversion, and storage technologies.
This is a non-exhaustive list, and the library of available technologies is actively expanding:

- **Electricity generation**: solar PV, wind, wave, tidal, natural gas combined cycle (NGCC), natural gas combustion turbines (NGCT), nuclear, grid
- **Hydrogen production**: PEM electrolysis, NG-SMR
- **Energy storage**: Li-ion batteries, long-duration energy storage (LDES), pumped storage hydropower (PSH)
- **Fuel cells**: H2 PEM fuel cells
- **Industrial processes**: ammonia synthesis, iron ore reduction, steel production, and more

## Getting Started

See the [Getting Started guide](https://h2integrate.readthedocs.io/en/latest/intro.html) for an introduction to H2Integrate.
The [Examples folder](./examples/) contain Jupyter notebooks, Python scripts, and sample YAML files for common usage scenarios.

## Publications

For a full list of publications, see the [Publications section in the documentation](https://h2integrate.readthedocs.io/en/latest/intro.html#publications).
Note: H2Integrate was previously known as GreenHEART, and some publications may refer to it by that name.

## Software Citation

If you use H2I or any of its components in your work, please cite this in your publications using the following BibTeX:

```bibtex
@software{brunik_2025_17903150,
  author = {Brunik, Kaitlin and
    Grant, Elenya and
    Thomas, Jared and
    Starke, Genevieve M and
    Martin, Jonathan and
    Ramos, Dakota and
    Koleva, Mariya and
    Reznicek, Evan and
    Hammond, Rob and
    Stanislawski, Brooke and
    Kiefer, Charlie and
    Irmas, Cameron and
    Vijayshankar, Sanjana and
    Riccobono, Nicholas and
    Frontin, Cory and
    Clark, Caitlyn and
    Barker, Aaron and
    Gupta, Abhineet and
    Kee, Benjamin (Jamie) and
    King, Jennifer and
    Jasa, John and
    Bay, Christopher},
  title = {H2Integrate: Holistic Hybrids Optimization and Design Tool},
  month = dec,
  year = 2025,
  publisher = {Zenodo},
  version = {0.4.0},
  doi = {10.5281/zenodo.17903150},
  url = {https://doi.org/10.5281/zenodo.17903150},
}
```

## Contributing

Interested in improving H2Integrate? Please see the [Contributor's Guide](./docs/CONTRIBUTING.md) for more information.
