Skip to content

Commit a831e12

Browse files
authored
Updating for v3.4.0 (#506)
# Updating for v3.4.0 <!-- Describe your feature here. Please include any code snippets or examples in this section. --> ## PR Checklist <!--Tick these boxes if they are complete, or format them as "[x]" for the markdown to render. --> - [ ] `RELEASE.md` has been updated to describe the changes made in this PR - [ ] Documentation - [ ] Docstrings are up-to-date - [ ] Related `docs/` files are up-to-date, or added when necessary - [ ] Documentation has been rebuilt successfully - [ ] Examples have been updated - [ ] Tests pass (If not, and this is expected, please elaborate in the tests section) - [ ] PR description thoroughly describes the new feature, bug fix, etc. ## Related issues <!--If one exists, link to a related GitHub Issue.--> ## Impacted areas of the software <!-- Replace the below example with any added or modified files, and briefly describe what has been changed or added, and why. --> - `path/to/file.extension` - `method1`: What and why something was changed in one sentence or less. ## Additional supporting information <!--Add any other context about the problem here.--> ## Test results, if applicable <!-- Add the results from unit tests and regression tests here along with justification for any failing test cases. --> <!-- __ For NREL use __ Release checklist: - [ ] Update the version in hopp/__init__.py - [ ] Verify docs builds correctly - [ ] Create a tag on the main branch in the NREL/HOPP repository and push - [ ] Ensure the Test PyPI build is successful - [ ] Create a release on the main branch -->
2 parents 0b3aee3 + 663b2cb commit a831e12

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+899
-359
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ the problem. All code and full tracebacks should be properly markdown formatted.
4949
<!-- Add your information here. -->
5050
- OS: <macOS 12.4>
5151
<!-- e.g. Ubuntu 20.04 or macOS 10.12 -->
52-
- Python version: <3.10.4>
52+
- Python version: <3.11.1>
5353
<!-- All OS: `python --version`-->
5454
- HOPP version: <0.1.1>
5555
<!--
@@ -66,7 +66,7 @@ the problem. All code and full tracebacks should be properly markdown formatted.
6666
### Relevant library versions
6767
<!--
6868
Use `pip freeze` to gather the relevant versions, and use the markdown table formatting as
69-
demonstrated below to replacing all relavant packages and their versions.
69+
demonstrated below to replacing all relevant packages and their versions.
7070
-->
7171

7272
| Package | Version |

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
shell: bash -el {0}
1212
strategy:
1313
matrix:
14-
python-version: ["3.10", "3.11"]
14+
python-version: ["3.11", "3.12", "3.13"]
1515

1616
steps:
1717
- uses: actions/checkout@v4

.github/workflows/conda_build.yml

Lines changed: 0 additions & 24 deletions
This file was deleted.

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,19 @@ As part of NREL's [Hybrid Energy Systems Research](https://www.nrel.gov/wind/hyb
99
software assesses optimal designs for the deployment of distributed, commercial, and utility-scale hybrid energy plants, particularly considering wind,
1010
solar and storage.
1111

12+
13+
## Part of the WETO Stack
14+
15+
HOPP is primarily developed with the support of the U.S. Department of Energy and is part of the [WETO Software Stack](https://nrel.github.io/WETOStack). For more information and other integrated modeling software, see:
16+
- [Portfolio Overview](https://nrel.github.io/WETOStack/portfolio_analysis/overview.html)
17+
- [Entry Guide](https://nrel.github.io/WETOStack/_static/entry_guide/index.html)
18+
- [Techno-Economic Modeling Workshop](https://nrel.github.io/WETOStack/workshops/user_workshops_2024.html#tea-and-cost-modeling)
19+
- [Systems Engineering Workshop](https://nrel.github.io/WETOStack/workshops/user_workshops_2024.html#systems-engineering)
20+
21+
1222
## Software requirements
1323

14-
- Python version 3.10, and 3.11 only
24+
- Python version 3.11 or higher
1525

1626
## Installing from Package Repositories
1727

RELEASE.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,46 @@
11
# Release Notes
2+
## Unreleased
3+
* Add `overwrite_fin_values` from H2Integrate to sync cost input methods
4+
* Bump minimum NREL-PySAM version to 7.0.0
5+
* Clarify that the `nominal_discount_rate` method of the `CustomFinancialModel` uses the Fisher equation
6+
* Bug-fix in `WindPlant` for handling model_input_file for PySAM simulations.
7+
* Remove `tidal_resource` as a required input to the tidal model because it's no longer required in the SSC model ([NREL/SSC PR #1305](https://github.com/NREL/ssc/pull/1305))
8+
* Add load following heuristic dispatch test
9+
* Consolidated utilities, renamed MHKConfig to MHKWaveConfig
10+
* Updated solar resource download to use GOES Aggregated PSM v4 download
11+
12+
## Version 3.3.0, April 30, 2025
13+
14+
* Added GenericPlant model ([PR #472](https://github.com/NREL/HOPP/pull/472)) which may be used to:
15+
- simulate grid and battery performance without resimulating generation of other technologies
16+
- represent the physics-based performance of a generation technology that is not included in HOPP
17+
* Loosened strictness of comparison for wind turbine config checking and added tests
18+
* Loosened strictness of comparison for wind turbine hub-height and wind resource hub-height
19+
* Updated workflow for specifying wind turbine parameters without specifying a turbine name with PySAM.
20+
* Added ability to download wind resource data from WTK-LED for Alaska ([PR #461](https://github.com/NREL/HOPP/pull/461))
21+
* Added ability to download wind resource data from BC-HRRR CONUS 60-minute (NOAA + NREL) for 2015-2023 ([PR #474](https://github.com/NREL/HOPP/pull/474))
22+
* Updated HOPP for pySAM 7.0.0 release ([PR #477](https://github.com/NREL/HOPP/pull/477))
23+
* Add long-duration energy storage (LDES) ([PR #471](https://github.com/NREL/HOPP/pull/471))
24+
* Bugfix for cycle counting in the minimum operating cost objective function - no longer throws an error
25+
* Bugfix for flicker mismatch; cases with a single `Point` now correctly work
26+
27+
28+
29+
## Version 3.3.0, April 30, 2025
30+
31+
* Added GenericPlant model ([PR #472](https://github.com/NREL/HOPP/pull/472)) which may be used to:
32+
- simulate grid and battery performance without resimulating generation of other technologies
33+
- represent the physics-based performance of a generation technology that is not included in HOPP
34+
* Loosened strictness of comparison for wind turbine config checking and added tests
35+
* Loosened strictness of comparison for wind turbine hub-height and wind resource hub-height
36+
* Updated workflow for specifying wind turbine parameters without specifying a turbine name with PySAM.
37+
* Added ability to download wind resource data from WTK-LED for Alaska ([PR #461](https://github.com/NREL/HOPP/pull/461))
38+
* Added ability to download wind resource data from BC-HRRR CONUS 60-minute (NOAA + NREL) for 2015-2023 ([PR #474](https://github.com/NREL/HOPP/pull/474))
39+
* Updated HOPP for pySAM 7.0.0 release ([PR #477](https://github.com/NREL/HOPP/pull/477))
40+
* Add long-duration energy storage (LDES) ([PR #471](https://github.com/NREL/HOPP/pull/471))
41+
* Bugfix for cycle counting in the minimum operating cost objective function - no longer throws an error
42+
* Bugfix for flicker mismatch; cases with a single `Point` now correctly work
43+
244

345

446
## Version 3.3.0, April 30, 2025

conda.recipe/meta.yaml

Lines changed: 0 additions & 57 deletions
This file was deleted.

conda_build.sh

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/api/hopp_interface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# HOPP Simulation Interface
22

3-
This class is the main interaction point for HOPP simulations. See [Examples](https://github.com/NREL/HOPP/tree/main/examples/workshop) for in-depth notebooks and configuration files.
3+
This class is the main interaction point for HOPP simulations. See [Examples](https://github.com/NREL/HOPP/tree/main/examples) for in-depth notebooks and configuration files.
44

55
```{eval-rst}
66
.. currentmodule:: hopp.simulation.hopp_interface

docs/api/technology/mhk_wave_plant.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ MHK Wave Generator class
1414
## Wave Plant Configuration
1515

1616
```{eval-rst}
17-
.. autoclass:: hopp.simulation.technologies.wave.mhk_wave_plant.MHKConfig
17+
.. autoclass:: hopp.simulation.technologies.wave.mhk_wave_plant.MHKWaveConfig
1818
:members:
1919
:undoc-members:
2020
```

examples/10-tidal-battery.ipynb

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,17 @@
1919
},
2020
{
2121
"cell_type": "code",
22-
"execution_count": 16,
22+
"execution_count": 1,
2323
"metadata": {},
24-
"outputs": [],
24+
"outputs": [
25+
{
26+
"name": "stdout",
27+
"output_type": "stream",
28+
"text": [
29+
"/Users/kbrunik/github/HOPP/examples/log/hybrid_systems_2025-07-23T14.55.37.333918.log\n"
30+
]
31+
}
32+
],
2533
"source": [
2634
"from hopp.simulation import HoppInterface"
2735
]
@@ -35,8 +43,7 @@
3543
"\n",
3644
"For the site information, the tidal resource data **must be pre-loaded** in the format given in the `Tidal_resource_timeseries.csv`.\n",
3745
"\n",
38-
"The tidal technology configuration requires the device rating (kw), power curve of tidal energy device as function of stream speeds (kW), and number of devices. Additionally there's a variable called `tidal_resource`, which is required for model instantiation but doesn't impact a timeseries simulation.\n",
39-
"\n",
46+
"The tidal technology configuration requires the device rating (kw), power curve of tidal energy device as function of stream speeds (kW), and number of devices.\n",
4047
"Note that the tidal model doesn't come with a default financial model. To address this, you must establish the `CustomFinancialModel` from HOPP.\n",
4148
"\n",
4249
"The `default_fin_config` contains all of the necessary parameters for the financial calculations.\n",
@@ -46,7 +53,7 @@
4653
},
4754
{
4855
"cell_type": "code",
49-
"execution_count": 17,
56+
"execution_count": 2,
5057
"metadata": {},
5158
"outputs": [],
5259
"source": [
@@ -144,7 +151,7 @@
144151
],
145152
"metadata": {
146153
"kernelspec": {
147-
"display_name": "pysam6",
154+
"display_name": "pysam7",
148155
"language": "python",
149156
"name": "python3"
150157
},

0 commit comments

Comments
 (0)