| Name | GreenHEART JSON |
| Version |
0.1.0a0
JSON |
| download |
| home_page | None |
| Summary | Green Hydrogen Energy and Renewable Technologies |
| upload_time | 2024-10-17 01:49:01 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.12,>=3.9 |
| license | **Note: The ProFAST model is distributed with GreenHEART but operates under a separate license agreement. Users must agree to the license terms of ProFAST located at `ProFAST/InternalUseTermsForDownloadableSoftware-ProFAST.docx`.** BSD 3-Clause License Copyright (c) 2020, 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. |
| keywords |
python3
hybrid-energy
wind-energy
solar-energy
layout-optimization
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# GreenHEART: Green Hydrogen Energy and Renewable Technologies
## GreenHEART: Green Hydrogen Energy and Renewable Technologies
[](https://badge.fury.io/py/greenheart)
[](https://pypi.python.org/pypi/greeheart)
[](https://opensource.org/licenses/BSD-3-Clause)
Hybrid project power-to-x component-level system performance and financial modeling for control and
design optimization. GreenHEART currently includes renewable energy, hydrogen, ammonia, and steel.
Other elements such as desalination systems, pipelines, compressors, and storage systems can also be
included as needed.
## Software requirements
- Python version 3.9, 3.10, 3.11 64-bit
- Other versions may still work, but have not been extensively tested at this time
## Installing from Package Repositories
1. GreenHEART is available as a PyPi package:
```bash
pip install greenheart
```
## Installing from Source
1. Using Git, navigate to a local target directory and clone repository:
```bash
git clone https://github.com/NREL/GreenHEART.git
```
2. Navigate to `GreenHEART`
```bash
cd GreenHEART
```
3. Create a new virtual environment and change to it. Using Conda and naming it 'greenheart':
```bash
conda create --name greenheart python=3.9 -y
conda activate greenheart
```
4. Install GreenHEART and its dependencies:
```bash
conda install -y -c conda-forge coin-or-cbc=2.10.8 glpk
pip install electrolyzer@git+https://github.com/jaredthomas68/electrolyzer.git@smoothing
pip install ProFAST@git+https://github.com/NREL/ProFAST.git
```
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 GreenHEART:
```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:
```bash
pip install -e ".[develop]"
```
- In one step, all dependencies can be installed as:
```bash
pip install -e ".[all]
```
5. 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/)
6. 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
```
7. Verify setup by running tests:
```bash
pytest
```
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`.
## Parallel processing for GreenHEART finite differences and design of experiments
GreenHEART is set up to run in parallel using MPI and PETSc for finite differencing and for design of
experiments runs through OpenMDAO. To use this capability you will need to follow the addtional installation
instruction below:
```bash
conda install -c conda-forge mpi4py petsc4py
```
For more details on implementation and installation, reference the documentation for OpenMDAO.
To to check that your installation is working, do the following:
```bash
cd tests/greenheart/
mpirun -n 2 pytest test_openmdao_mpi.py
```
## Getting Started
The [Examples](./examples/) contain Jupyter notebooks and sample YAML files for common usage
scenarios in GreenHEART. These are actively maintained and updated to demonstrate GreenHEART's
capabilities. For full details on simulation options and other features, documentation is
forthcoming.
## Contributing
Interested in improving GreenHEART? Please see the [Contributing](./CONTRIBUTING.md) section for more information.
Raw data
{
"_id": null,
"home_page": null,
"name": "GreenHEART",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": "python3, hybrid-energy, wind-energy, solar-energy, layout-optimization",
"author": null,
"author_email": "NREL <dguittet@nrel.gov>",
"download_url": "https://files.pythonhosted.org/packages/4a/50/b5e8e207399fb53dcf1b01592354570bf41464426f8c32275faed05168a7/greenheart-0.1.0a0.tar.gz",
"platform": null,
"description": "# GreenHEART: Green Hydrogen Energy and Renewable Technologies\n\n## GreenHEART: Green Hydrogen Energy and Renewable Technologies\n\n[](https://badge.fury.io/py/greenheart)\n\n[](https://pypi.python.org/pypi/greeheart)\n[](https://opensource.org/licenses/BSD-3-Clause)\n\nHybrid project power-to-x component-level system performance and financial modeling for control and\ndesign optimization. GreenHEART currently includes renewable energy, hydrogen, ammonia, and steel.\nOther elements such as desalination systems, pipelines, compressors, and storage systems can also be\nincluded as needed.\n\n\n## Software requirements\n\n- Python version 3.9, 3.10, 3.11 64-bit\n- Other versions may still work, but have not been extensively tested at this time\n\n## Installing from Package Repositories\n\n1. GreenHEART is available as a PyPi package:\n\n ```bash\n pip install greenheart\n ```\n\n## Installing from Source\n\n1. Using Git, navigate to a local target directory and clone repository:\n\n ```bash\n git clone https://github.com/NREL/GreenHEART.git\n ```\n\n2. Navigate to `GreenHEART`\n\n ```bash\n cd GreenHEART\n ```\n\n3. Create a new virtual environment and change to it. Using Conda and naming it 'greenheart':\n\n ```bash\n conda create --name greenheart python=3.9 -y\n conda activate greenheart\n ```\n\n4. Install GreenHEART and its dependencies:\n\n ```bash\n conda install -y -c conda-forge coin-or-cbc=2.10.8 glpk\n pip install electrolyzer@git+https://github.com/jaredthomas68/electrolyzer.git@smoothing\n pip install ProFAST@git+https://github.com/NREL/ProFAST.git\n ```\n\n Note if you are on Windows, you will have to manually install Cbc: https://github.com/coin-or/Cbc.\n\n - If you want to just use GreenHEART:\n\n ```bash\n pip install . \n ```\n\n - If you want to work with the examples:\n\n ```bash\n pip install \".[examples]\"\n ```\n\n - If you also want development dependencies for running tests and building docs: \n\n ```bash\n pip install -e \".[develop]\"\n ```\n\n - In one step, all dependencies can be installed as:\n\n ```bash\n pip install -e \".[all]\n ```\n\n5. The functions which download resource data require an NREL API key. Obtain a key from:\n\n [https://developer.nrel.gov/signup/](https://developer.nrel.gov/signup/)\n\n6. To set up the `NREL_API_KEY` and `NREL_API_EMAIL` required for resource downloads, you can create\n Environment Variables called `NREL_API_KEY` and `NREL_API_EMAIL`. Otherwise, you can keep the key\n in a new file called \".env\" in the root directory of this project.\n\n Create a file \".env\" that contains the single line:\n\n ```bash\n NREL_API_KEY=key\n NREL_API_EMAIL=your.name@email.com\n ```\n\n7. Verify setup by running tests:\n\n ```bash\n pytest\n ```\n\n\n2. To set up `NREL_API_KEY` for resource downloads, first refer to section 7 and 8 above. But for\n the `.env` file method, the file should go in the working directory of your Python project, e.g.\n directory from where you run `python`.\n\n## Parallel processing for GreenHEART finite differences and design of experiments\n\nGreenHEART is set up to run in parallel using MPI and PETSc for finite differencing and for design of\nexperiments runs through OpenMDAO. To use this capability you will need to follow the addtional installation\ninstruction below:\n\n```bash\nconda install -c conda-forge mpi4py petsc4py\n```\n\nFor more details on implementation and installation, reference the documentation for OpenMDAO.\n\nTo to check that your installation is working, do the following:\n\n```bash\ncd tests/greenheart/\nmpirun -n 2 pytest test_openmdao_mpi.py\n```\n\n## Getting Started\n\nThe [Examples](./examples/) contain Jupyter notebooks and sample YAML files for common usage\nscenarios in GreenHEART. These are actively maintained and updated to demonstrate GreenHEART's\ncapabilities. For full details on simulation options and other features, documentation is\nforthcoming.\n\n## Contributing\n\nInterested in improving GreenHEART? Please see the [Contributing](./CONTRIBUTING.md) section for more information.\n",
"bugtrack_url": null,
"license": "**Note: The ProFAST model is distributed with GreenHEART but operates under a separate license agreement. Users must agree to the license terms of ProFAST located at `ProFAST/InternalUseTermsForDownloadableSoftware-ProFAST.docx`.** BSD 3-Clause License Copyright (c) 2020, 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. ",
"summary": "Green Hydrogen Energy and Renewable Technologies",
"version": "0.1.0a0",
"project_urls": {
"changelog": "https://github.com/NREL/GreenHEART/blob/main/CHANGELOG.md",
"issues": "https://github.com/NREL/GreenHEART/issues",
"source": "https://github.com/NREL/GreenHEART"
},
"split_keywords": [
"python3",
" hybrid-energy",
" wind-energy",
" solar-energy",
" layout-optimization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7cbc1b0cd117fd3dace1487811c97b330ab7348a76e6853cbf7107bee8d4c1cb",
"md5": "eec058df9ab7821334494a7f845dbc19",
"sha256": "dee5d711f68e0c31332ca9e7cb781561da7c97f365359047f849c997ee5220b0"
},
"downloads": -1,
"filename": "GreenHEART-0.1.0a0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eec058df9ab7821334494a7f845dbc19",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 5755,
"upload_time": "2024-10-17T01:48:55",
"upload_time_iso_8601": "2024-10-17T01:48:55.992077Z",
"url": "https://files.pythonhosted.org/packages/7c/bc/1b0cd117fd3dace1487811c97b330ab7348a76e6853cbf7107bee8d4c1cb/GreenHEART-0.1.0a0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4a50b5e8e207399fb53dcf1b01592354570bf41464426f8c32275faed05168a7",
"md5": "7074e7d6a40dffb1ef386f176998f276",
"sha256": "78f691921481ffc23363d02ae9ee5c0ceb740002e9daa097ebb4603334bcf0bc"
},
"downloads": -1,
"filename": "greenheart-0.1.0a0.tar.gz",
"has_sig": false,
"md5_digest": "7074e7d6a40dffb1ef386f176998f276",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 3446233,
"upload_time": "2024-10-17T01:49:01",
"upload_time_iso_8601": "2024-10-17T01:49:01.882637Z",
"url": "https://files.pythonhosted.org/packages/4a/50/b5e8e207399fb53dcf1b01592354570bf41464426f8c32275faed05168a7/greenheart-0.1.0a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-17 01:49:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NREL",
"github_project": "GreenHEART",
"github_not_found": true,
"lcname": "greenheart"
}
