Metadata-Version: 2.4
Name: nlr-hercules
Version: 2.1
Summary: Hybrid plant emulation tool.
Author-email: Genevieve Starke <Genevieve.Starke@nlr.gov>, "Michael (Misha) Sinner" <Michael.Sinner@nlr.gov>, Paul Fleming <Paul.Fleming@nlr.gov>, Brooke Stanislawski <Brooke.Stanislawski@nlr.gov>
License: BSD 3-Clause License
        
        Copyright (c) 2025, Alliance for Energy Innovation 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: Homepage, https://github.com/NatLabRockies/hercules
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy~=2.0
Requires-Dist: matplotlib~=3.8
Requires-Dist: pandas~=2.0
Requires-Dist: floris~=4.3
Requires-Dist: nrel-pysam<8,>=6
Requires-Dist: jupyter
Requires-Dist: netCDF4
Requires-Dist: rainflow~=3.2
Requires-Dist: tqdm~=4.66
Requires-Dist: polars~=1.0
Requires-Dist: pyarrow
Requires-Dist: h5py~=3.10
Requires-Dist: NREL-rex[hsds]
Requires-Dist: utm
Requires-Dist: cartopy
Requires-Dist: openmeteo_requests
Requires-Dist: requests_cache
Requires-Dist: retry_requests
Requires-Dist: electrolyzer
Provides-Extra: docs
Requires-Dist: jupyter-book==1.0.4; extra == "docs"
Requires-Dist: sphinx-book-theme; extra == "docs"
Provides-Extra: develop
Requires-Dist: pytest; extra == "develop"
Requires-Dist: pre-commit; extra == "develop"
Requires-Dist: ruff; extra == "develop"
Requires-Dist: isort; extra == "develop"
Dynamic: license-file

# README

# hercules
Hercules is an open-source tool for hybrid plant simulation in real time. Hercules  co-simulates multiple technologies to form a hybrid plant that can include wind, solar, storage and electrolyzers. The entire hybrid plant can be controlled using [Hycon](https://github.com/NatLabRockies/hycon).

## Part of the WETO Stack

Hercules is primarily developed with the support of the U.S. Department of Energy and is part of the [WETO Software Stack](https://natlabrockies.github.io/WETOStack). For more information and other integrated modeling software, see:
- [Portfolio Overview](https://natlabrockies.github.io/WETOStack/portfolio_analysis/overview.html)
- [Entry Guide](https://natlabrockies.github.io/WETOStack/_static/entry_guide/index.html)
- [High-Fidelity Modeling Workshop](https://natlabrockies.github.io/WETOStack/workshops/user_workshops_2024.html#high-fidelity-modeling)

# Documentation

For detailed instructions see the [online documentation](https://natlabrockies.github.io/hercules/)

# Installation

For installation instructions see: [installation instructions](https://natlabrockies.github.io/hercules/install.html)
