hopp

https://github.com/nrel/hopp

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
1 of 34 committers (2.9%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (18.1%) to scientific vocabulary

Last synced: 10 months ago · JSON representation

Repository

Basic Info

Host: GitHub
Owner: NREL
License: bsd-3-clause
Language: Python
Default Branch: main
Homepage: https://hopp.readthedocs.io/
Size: 632 MB

Statistics

Stars: 31
Watchers: 9
Forks: 62
Open Issues: 68
Releases: 9

Created over 6 years ago · Last pushed 10 months ago

Metadata Files

Readme Contributing License

HOPP: Hybrid Optimization and Performance Platform

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

Software requirements

Python version 3.10, and 3.11 only

Installing from Package Repositories

HOPP is available as a PyPi package:

bash pip install HOPP

Installing from Source

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

bash git clone https://github.com/NREL/HOPP.git
Navigate to HOPP

bash cd HOPP
Create a new virtual environment and change to it. Using Conda and naming it 'hopp':

bash conda create --name hopp python=3.11 -y conda activate hopp
Install HOPP and its dependencies:

bash conda install -y -c conda-forge coin-or-cbc glpk

Note if you are on Windows, you will have to manually install Cbc: https://github.com/coin-or/Cbc.

- If you want to just use HOPP:

   ```bash
   pip install .  
   ```

- If you want to work with the examples:

   ```bash
   pip install ".[examples]"
   ```

- If you also want development dependencies for running tests and building docs. Note the `-e` flag which installs HOPP in-place so you can edit the HOPP package files:  

   ```bash
   pip install -e ".[develop]"
   ```

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:

bash NREL_API_KEY=key NREL_API_EMAIL=your.name@email.com
Verify setup by running tests:

bash pytest tests/hopp
To set up NREL_API_KEY for resource downloads, first refer to section 6 and 7 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 Contributor's Guide for more information.

Owner

Name: National Renewable Energy Laboratory
Login: NREL
Kind: organization
Location: Golden, CO

Website: http://www.nrel.gov
Repositories: 599
Profile: https://github.com/NREL

GitHub Events

Total

Create event: 14
Release event: 5
Issues event: 58
Watch event: 7
Delete event: 9
Issue comment event: 73
Push event: 123
Pull request event: 166
Pull request review event: 395
Pull request review comment event: 385
Fork event: 18

Last Year

Create event: 14
Release event: 5
Issues event: 58
Watch event: 7
Delete event: 9
Issue comment event: 73
Push event: 123
Pull request event: 166
Pull request review event: 395
Pull request review comment event: 385
Fork event: 18

Committers

Last synced: about 1 year ago

All Time

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

Past Year

Commits: 206
Committers: 12
Avg Commits per committer: 17.167
Development Distribution Score (DDS): 0.723

Top Committers

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	18
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 (Top 20 + Academic)

nrel.gov: 18 .nrel.gov: 1 desktop-246ch3h.localdomain: 1 jannoni-31697s.nrel.gov: 1 mines.edu: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time

Total issues: 133
Total pull requests: 471
Average time to close issues: 3 months
Average time to close pull requests: 24 days
Total issue authors: 16
Total pull request authors: 27
Average comments per issue: 0.3
Average comments per pull request: 0.53
Merged pull requests: 360
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 53
Pull requests: 184
Average time to close issues: 11 days
Average time to close pull requests: 5 days
Issue authors: 8
Pull request authors: 12
Average comments per issue: 0.09
Average comments per pull request: 0.58
Merged pull requests: 146
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

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

Pull Request Authors

jaredthomas68 (107)
kbrunik (94)
johnjasa (40)
elenya-grant (39)
camirmas (32)
bayc (31)
RHammond2 (21)
dguittet (18)
Matthew-Boyd (12)
cfrontin (12)
ckiefer14 (11)
nRiccobo (8)
dakotaramos (8)
genevievestarke (8)
jmartin4nrel (6)

Top Labels

Issue Labels

refactor (10) enhancement (8) bug (8) documentation (5) dependencies (4) high priority (2) awaiting release (2) medium priority (2) low priority (1)

Pull Request Labels

enhancement (44) refactor (17) bug (17) high priority (14) documentation (11) low priority (4) dependencies (3) medium priority (2)

Packages

Total packages: 3
Total downloads:
- pypi 316 last-month

Total dependent packages: 1
(may contain duplicates)
Total dependent repositories: 1
(may contain duplicates)
Total versions: 41
Total maintainers: 3

proxy.golang.org: github.com/NREL/HOPP

Documentation: https://pkg.go.dev/github.com/NREL/HOPP#section-documentation
License: bsd-3-clause
Latest release: v3.3.0+incompatible
published about 1 year ago

Versions: 11
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 10 months ago

proxy.golang.org: github.com/nrel/hopp

Documentation: https://pkg.go.dev/github.com/nrel/hopp#section-documentation
License: bsd-3-clause
Latest release: v3.3.0+incompatible
published about 1 year ago

Versions: 11
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 10 months ago

pypi.org: hopp

Hybrid Systems Optimization and Performance Platform.

Documentation: https://hopp.readthedocs.io/
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.
Latest release: 3.3.0
published about 1 year ago

Versions: 19
Dependent Packages: 1
Dependent Repositories: 1
Downloads: 316 Last month

Rankings

Dependent packages count: 4.8%

Forks count: 6.5%

Average: 12.2%

Stargazers count: 13.9%

Downloads: 14.0%

Dependent repos count: 21.6%

Maintainers (3)

cbay dguittet qualand

Last synced: 10 months ago

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

hopp

Science Score: 36.0%

Repository

Basic Info

Statistics

Metadata Files

README.md

HOPP: Hybrid Optimization and Performance Platform

Software requirements

Installing from Package Repositories

Installing from Source

Getting Started

Contributing

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

proxy.golang.org: github.com/NREL/HOPP

Rankings

proxy.golang.org: github.com/nrel/hopp

Rankings

pypi.org: hopp

Rankings

Maintainers (3)

Dependencies