Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NREL/HOPP
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/NREL/HOPP
- Owner: NREL
- License: bsd-3-clause
- Created: 2019-11-04T17:13:57.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-29T17:14:33.000Z (4 months ago)
- Last Synced: 2024-09-10T02:19:07.056Z (4 months ago)
- Language: Jupyter Notebook
- Size: 536 MB
- Stars: 21
- Watchers: 9
- Forks: 44
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- open-sustainable-technology - HOPP - Assesses optimal designs for the deployment of utility-scale hybrid energy plants, particularly considering wind, solar and storage. (Energy Systems / Renewable Energy Integration)
README
# Hybrid Optimization and Performance Platform
As part of NREL's [Hybrid Energy Systems Research](https://www.nrel.gov/wind/hybrid-energy-systems-research.html), 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
1. HOPP is available as a PyPi package:
```
pip install HOPP
```
## Installing from Source
1. Using Git, navigate to a local target directory and clone repository:
```
git clone https://github.com/NREL/HOPP.git
```
2. Navigate to `HOPP`
```
cd HOPP
```
3. 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
```
4. 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
```
5. Install HOPP:
```
pip install -e .
```
6. The functions which download resource data require an NREL API key. Obtain a key from:
[https://developer.nrel.gov/signup/](https://developer.nrel.gov/signup/)
7. 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]
```
8. Verify setup by running tests:
```
pytest tests/hopp
```
2. 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](./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](https://hopp.readthedocs.io/en/latest/).
## Contributing
Interested in improving HOPP? Please see the [Contributing](./CONTRIBUTING.md) section for more information.