HOPP

Assesses optimal designs for the deployment of utility-scale hybrid energy plants, particularly considering wind, solar and storage.
https://github.com/NREL/HOPP

Category: Energy Systems
Sub Category: Renewable Energy Integration

Keywords from Contributors

wind openmdao systems-engineering wisdem wind-energy

Last synced: about 19 hours ago
JSON representation

Repository metadata

Host: GitHub
URL: https://github.com/NREL/HOPP
Owner: NREL
License: bsd-3-clause
Created: 2019-11-04T17:13:57.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2025-04-17T21:40:58.000Z (10 days ago)
Last Synced: 2025-04-17T22:45:44.979Z (10 days ago)
Language: Python
Homepage: https://hopp.readthedocs.io/
Size: 598 MB
Stars: 26
Watchers: 9
Forks: 54
Open Issues: 68
Releases: 8
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE

Hybrid Optimization and Performance Platform

As part of NREL's Hybrid Energy Systems Research, this
software assesses optimal designs for the deployment of utility-scale hybrid energy plants, particularly considering wind,
solar and storage.

Software requirements

Python version 3.8, 3.9, 3.10 64-bit
Other versions may still work, but have not been extensively tested at this time

Installing from Package Repositories

HOPP is available as a PyPi package:
```
pip install HOPP
```

Installing from Source

Using Git, navigate to a local target directory and clone repository:
```
git clone https://github.com/NREL/HOPP.git
```
Navigate to HOPP
```
cd HOPP
```
Create a new virtual environment and change to it. Using Conda and naming it 'hopp':
```
conda create --name hopp python=3.8 -y
conda activate hopp
```
Install dependencies:
```
conda install -c conda-forge coin-or-cbc=2.10.8 -y
conda install -c conda-forge glpk -y
pip install -r requirements.txt
```
Note if you are on Windows, you will have to manually install Cbc: https://github.com/coin-or/Cbc

If you also want development dependencies for running tests and building docs:
```
pip install -r requirements-dev.txt
```
Install HOPP:
```
pip install -e .
```
The functions which download resource data require an NREL API key. Obtain a key from:

https://developer.nrel.gov/signup/
To set up the NREL_API_KEY and NREL_API_EMAIL required for resource downloads, you can create Environment Variables called NREL_API_KEY and NREL_API_EMAIL. Otherwise, you can keep the key in a new file called ".env" in the root directory of this project.

Create a file ".env" that contains the single line:
```
NREL_API_KEY=key
[email protected]
```
Verify setup by running tests:
```
pytest tests/hopp
```
To set up NREL_API_KEY for resource downloads, first refer to section 7 and 8 above. But for the .env file method,
the file should go in the working directory of your Python project, e.g. directory from where you run python.

Getting Started

The Examples contain Jupyter notebooks and sample YAML files for common usage scenarios in HOPP. These are actively maintained and updated to demonstrate HOPP's capabilities. For full details on simulation options and other features, see the documentation.

Contributing

Interested in improving HOPP? Please see the Contributing section for more information.

Owner metadata

Name: National Renewable Energy Laboratory
Login: NREL
Email:
Kind: organization
Description:
Website: http://www.nrel.gov
Location: Golden, CO
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/1906800?v=4
Repositories: 599
Last ynced at: 2024-12-18T09:41:07.898Z
Profile URL: https://github.com/NREL

GitHub Events

Total

Create event: 12
Release event: 4
Issues event: 57
Watch event: 2
Delete event: 6
Issue comment event: 67
Push event: 106
Pull request event: 144
Pull request review event: 380
Pull request review comment event: 379
Fork event: 11

Last Year

Create event: 12
Release event: 4
Issues event: 57
Watch event: 2
Delete event: 6
Issue comment event: 67
Push event: 106
Pull request event: 144
Pull request review event: 380
Pull request review comment event: 379
Fork event: 11

Committers metadata

Last synced: 5 days ago

Total Commits: 1,461
Total Committers: 34
Avg Commits per committer: 42.971
Development Distribution Score (DDS): 0.782

Commits in past year: 303
Committers in past year: 12
Avg Commits per committer in past year: 25.25
Development Distribution Score (DDS) in past year: 0.617

Name	Email	Commits
Jared Thomas	j**8@g**m	318
kbrunik	k**k@g**m	214
dguittet	d**t@n**v	148
Evan	E**k@n**v	129
bayc	c**y@g**m	104
Aaron Barker	b**9@g**m	103
elenya-grant	1****t	76
Cameron Irmas	c**s@p**m	51
Masha	m**a@n**v	45
nriccobo	N**o@n**v	32
Genevieve Starke	G**e@n**v	29
Cory Frontin	c**n@n**v	28
RHammond2	1****2	25
WHamilt2	w**n@n**v	24
King	j**g@n**v	18
John Jasa	j**1@g**m	17
Matthew Boyd	m**d@g**m	17
Dakota Ramos	d**s@n**v	15
jmartin4nrel	j**n@n**v	15
PJ Stanley	a**y@n**v	13
Bhaskar	p**r@n**v	9
svijaysh	s**h@n**v	6
Jamie	J**e@n**v	6
AbhineetGupta	a**a@n**v	5
jlcox119	j**x@m**u	3
Kiefer	c**r@n**v	3
Caitlyn E. Clark, PhD	c**k@n**v	1
King	j**i@j**v	1
John Jasa	j**a@D**n	1
Jasa	j**a@n**v	1
and 4 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 137
Total pull requests: 325
Average time to close issues: 3 months
Average time to close pull requests: 29 days
Total issue authors: 16
Total pull request authors: 24
Average comments per issue: 0.39
Average comments per pull request: 0.57
Merged pull request: 257
Bot issues: 0
Bot pull requests: 0

Past year issues: 58
Past year pull requests: 115
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 8 days
Past year issue authors: 8
Past year pull request authors: 10
Past year average comments per issue: 0.28
Past year average comments per pull request: 0.5
Past year merged pull request: 97
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/NREL/HOPP

Top Issue Authors

camirmas (50)
jaredthomas68 (19)
johnjasa (17)
bayc (12)
elenya-grant (12)
kbrunik (11)
dakotaramos (3)
RHammond2 (3)
qualand (2)
dguittet (2)
ppinchuk (1)
grantbuster (1)
cfrontin (1)
MRossol (1)
awabbes (1)

Top Pull Request Authors

kbrunik (70)
jaredthomas68 (65)
camirmas (29)
elenya-grant (22)
bayc (18)
dguittet (18)
johnjasa (17)
Matthew-Boyd (12)
RHammond2 (12)
cfrontin (11)
ckiefer14 (11)
nRiccobo (8)
genevievestarke (5)
dakotaramos (5)
ereznicek (5)

Top Issue Labels

enhancement (14)
refactor (12)
bug (8)
documentation (7)
dependencies (6)
medium priority (5)
high priority (3)
low priority (2)
awaiting release (2)
help wanted (1)
question (1)

Top Pull Request Labels

enhancement (29)
refactor (14)
bug (11)
high priority (7)
documentation (6)
dependencies (2)
low priority (2)
medium priority (1)

Package metadata

Total packages: 1
Total downloads:
- pypi: 1,289 last-month
Total dependent packages: 1
Total dependent repositories: 1
Total versions: 18
Total maintainers: 3

pypi.org: hopp

Hybrid Systems Optimization and Performance Platform.

Homepage:
Documentation: https://hopp.readthedocs.io/
Licenses: 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.
Latest release: 3.2.0 (published about 1 month ago)
Last Synced: 2025-04-26T13:40:58.834Z (2 days ago)
Versions: 18
Dependent Packages: 1
Dependent Repositories: 1
Downloads: 1,289 Last month
Rankings:
- Dependent packages count: 4.752%
- Forks count: 6.527%
- Average: 12.173%
- Stargazers count: 13.908%
- Downloads: 14.05%
- Dependent repos count: 21.628%
Maintainers (3)
- cbay
- dguittet
- qualand

Dependencies

.github/workflows/ci.yml actions

actions/checkout v3 composite
actions/setup-python v3 composite

.github/workflows/conda_build.yml actions

actions/checkout v2 composite
conda-incubator/setup-miniconda v2 composite

.github/workflows/publish_to_pypi.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite

requirements-dev.txt pypi

Cython * development
NREL-PySAM ==3.0.0 development
Pillow * development
Pyomo >=6.1.2 development
cmake * development
floris * development
future * development
global_land_mask * development
matplotlib * development
numpy * development
pandas * development
pint * development
pvmismatch * development
pysolar * development
pytest * development
python-dotenv * development
pytz * development
requests * development
scipy * development
sphinx * development
sphinx-copybutton * development
sphinx-rtd-theme * development
timezonefinder * development
urllib3 * development

requirements.txt pypi

Cython *
NREL-PySAM ==3.0.0
NREL-PySAM-stubs ==3.0.0
Pillow *
Pyomo >=6.1.2
diskcache *
fastkml *
floris *
future *
global_land_mask *
humpday *
hybridbosse *
lcoe *
lxml *
matplotlib *
nevergrad *
nlopt *
numpy *
numpy-financial *
optuna *
pandas *
pint *
pvmismatch *
pyDOE2 *
pymoo *
pyproj *
pysolar *
pysot *
python-dotenv *
python-rapidjson *
pytz *
requests *
scikit-learn *
scikit-optimize *
scipy *
setuptools *
shapely >=1.8.5,<2.0.0
timezonefinder *
urllib3 *

setup.py pypi

Score: 15.23514878194701

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology