Added FLORIS wind plant model #372

elenya-grant · 2025-11-20T22:55:01Z

Added FLORIS wind plant model

Added wind plant performance model for FLORIS.

This model was developed with an emphasis on usability for design sweeps, meaning that some inputs in floris_config file are over-written to use possible design variables such as number of wind turbines and turbine hub-height. Aka - this is not able to accommodate all the possible use-cases that a user may have with running FLORIS in H2I to keep the initial implementation somewhat simple.

Type of Contribution

General PR Checklist

CHANGELOG.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 (if applicable)
Tests pass (If not, and this is expected, please elaborate in the tests section)
Added tests for new functionality or bug fixes
PR description thoroughly describes the new feature, bug fix, etc.

New Technology Checklist

Related issues

Created Issue Enable functionality to run FLORIS file with custom layout and/or multiple turbine types #423 to address some reviewer feedback regarding FLORIS usage.
Issue Develop a generalized caching system for components #410 and PR Baseclass for Caching Functionality #424 were created to address reviewer feedback around Caching. This PR was updated once PR Baseclass for Caching Functionality #424 was merged in and now utilizes the CacheModelBaseClass
Issue Add air density adjustment for elevation to FLORIS wrapper #439 would be resolved

Impacted areas of the software

Modified files

h2integrate/core/model_baseclasses.py
- CacheBaseConfig.__attrs_post_init__(): updated to only create cache_dir if caching is enabled.
h2integrate/converters/hopp/test/test_hopp_caching.py
- test_hopp_wrapper_cache_filenames: added cleanup to test to remove folder and files created within test
h2integrate/preprocess/test/test_wind_turbine_file_tools.py: added more detailed test for testing floris preprocessing tools
docs/misc_resources/turbine_models_library_preprocessing.ipynb: added docs to show usage of export_turbine_to_floris_format() function

New files

h2integrate/converters/wind/floris.py
- FlorisWindPlantPerformanceModel: performance model for FLORIS.
- FlorisWindPlantPerformanceConfig: configuration class for FlorisWindPlantPerformanceModel
examples/floris_example/*: example files to run FLORIS
tests/h2integrate/test_all_examples.py::test_floris_example: integration test for floris example
h2integrate/converters/wind/test/test_floris_wind.py: unit tests for FlorisWindPlantPerformanceModel
library/floris_v4_default_template.yaml: floris config with wake parameters
library/floris_turbine_Vestas_660kW.yaml: floris config for vestas 660 kW turbine.
h2integrate/converters/wind/tools/resource_tools.py: new file containing tool related to wind resource:
- calculate_air_density(): estimate air density for a specific elevation
- weighted_average_wind_data_for_hubheight(): weighted average of wind resource data of two hub-heights
- average_wind_data_for_hubheight(): average wind data over two resource heights
h2integrate/converters/wind/tools/test/test_resource_tools.py: tests for all methods in h2integrate/converters/wind/tools/resource_tools.py

Additional supporting information

Test results, if applicable

…name

…ris example

review-notebook-app · 2026-01-06T18:09:56Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

johnjasa

Thanks for this! I love that we're moving closer and closer to having all the technology models we need integrated into H2I well.

I've made some changes directly to the code and had a few small comments. I welcome feedback from others but think this is in a good spot and can be built upon as needed in further PRs.

What other features need to come in for us to fully replace the HOPP technology models in the examples with a mix of wind/solar/battery? Would we be able to do that once this PR comes in or does more functionality need to be added to H2I?

johnjasa · 2026-01-06T19:37:15Z

h2integrate/converters/wind/floris.py

+    default_turbulence_intensity: float = field()
+    operational_losses: float = field(validator=range_val(0.0, 100.0))
+    hub_height: float = field(default=-1, validator=validators.ge(-1))
+    floris_operation_model: str = field(default="cosine-loss")


Non-blocking suggestion: rename to operation_model as the floris is unnecessary because we're already in that technology model?

johnjasa · 2026-01-06T19:47:47Z

h2integrate/converters/wind/floris.py

+        # NOTE: could update air density based on elevation if elevation is included
+        # in the resource data.
+        # would need to duplicate the ``calculate_air_density`` function from HOPP


Could you please make an issue for this and add context/links to the HOPP code where useful?

done - Created Issue #439

jk - I'm adding it into the floris wrapper now.

johnjasa · 2026-01-06T19:59:15Z

h2integrate/converters/wind/floris.py

+        )
+
+        # make layout for number of turbines
+        if self.layout_mode == "basicgrid":


@elenya-grant, where have you landed on how layout_mode is used here? Correct me if I'm wrong, but currently the only supported layout_mode is basicgrid? I say this because if it's not, then x_pos and y_pos are not created and they're later used for floris_farm

johnjasa · 2026-01-06T20:01:10Z

h2integrate/converters/wind/floris.py

+        floris_config["farm"].update(floris_farm)
+
+        # initialize FLORIS
+        floris_config["flow_field"].update({"turbulence_intensities": []})


Is this line necessary if you're setting the turbulence intensities as part of the time_series wind data? Does this blank turbulence intensities list just get overwritten? I'd suggest removing it if it's not strictly needed.

the turbulence intensity thing is a bit complicated. But, simply, this does need to be here or else it'll fail because its a required input to the Floris TimeSeries object and a user may not include it in the floris_wake_config.

on your question about layout_mode - The only layout mode option is basicgrid and so an error will be thrown if the layout mode isn't basic grid (because x_pos and y_pos won't exist). Once we get more layout options, I'd be nice to incorporate handling layout stuff into the WindPerformanceBaseClass and have a shared WindPerformanceBaseConfig that can be used with FlorisWindPlantPerformanceModel and PYSAMWindPlantPerformanceModel

Understood, thanks for your explanation here. I agree with your approach

johnjasa · 2026-01-06T20:11:00Z

h2integrate/converters/wind/tools/resource_tools.py

+    return rho
+
+
+def calculate_air_density_losses(elevation_m: float) -> float:


It looks like this and the above function aren't used anywhere? I'd suggest removing until they're used.

h2integrate/converters/wind/tools/resource_tools.py

johnjasa · 2026-01-06T20:22:19Z

h2integrate/resource/wind/wind_resource_base.py

            "pressure": "atm",
            "precipitation_rate": "mm/h",
            "relative_humidity": "percent",
+            "is_day": "percent",


I looked into this and agree with @elenya-grant's findings:

Test 1: Setting unitless input to 0.5 ============================================================ Input (unitless): [0.5] Output (unitless): [0.5] ============================================================ Test 2: Setting percent input to 50 ============================================================ Input (percent): [50.] Output (percent): [50.] ============================================================ Test 3: Set unitless=0.5, read as percent ============================================================ Set as unitless: 0.5 Read as unitless: [0.5] Read as percent: [50.] ============================================================ Test 4: Set percent=50, read as unitless ============================================================ Set as percent: 50.0 Read as percent: [50.] Read as unitless: [0.5]

elenya-grant · 2026-01-06T22:31:40Z

Thanks for this! I love that we're moving closer and closer to having all the technology models we need integrated into H2I well.

I've made some changes directly to the code and had a few small comments. I welcome feedback from others but think this is in a good spot and can be built upon as needed in further PRs.

What other features need to come in for us to fully replace the HOPP technology models in the examples with a mix of wind/solar/battery? Would we be able to do that once this PR comes in or does more functionality need to be added to H2I?

I think we need whatever the HOPP dispatch/battery functionality is then we can move away from it. We may also need to add more wind layout options if any of the examples that use HOPP use a layout that isn't basicgrid

genevievestarke

I think this looks good to be merged in! My last question is if hub_height is something that could be optimized since it's exposed to OpenMDAO?

genevievestarke · 2026-01-08T17:57:41Z

h2integrate/converters/wind/floris.py

+                "`layout` dictionary. Please set the layout in "
+                "floris_wake_config['farm']['layout_x'] and floris_wake_config['farm']['layout_y']"
+                " to empty lists"
+            )


I like this error message!

jaredthomas68

I have a few outstanding concerns, but looking good overall.

h2integrate/converters/wind/tools/resource_tools.py

h2integrate/converters/wind/floris.py

jaredthomas68 · 2026-01-08T20:04:56Z

h2integrate/resource/wind/wind_resource_base.py

            "pressure": "atm",
            "precipitation_rate": "mm/h",
            "relative_humidity": "percent",
+            "is_day": "percent",


I think your results @johnjasa show demonstrate exactly what I said. Percent is between 0 and 100, unitless the range may be 0 to 1. The results above show setting as percent=50 results in a unitless of 0.5.

I think the docs page may be wrong. I've run into issues with this elsewhere. I think unitless = percent/100 and percent is unitless*100, see the test in openmdao for percentage where a unitless of 0.05 corresponds to a percentage of 5.

…resource tools

elenya-grant · 2026-01-09T20:05:15Z

@jaredthomas68:

Thanks for your review. Here's a summary of the things I did to address your feedback:

I added tests in for the functions in resource_tools.py
I made an issue about the wind shear this (Issue Wind speed estimate at hub-height using shear #444)
I fixed the units for is_day

…g resource data method

jaredthomas68

Looks good, thanks!

h2integrate/converters/wind/floris.py

elenya-grant added 8 commits November 13, 2025 17:40

added draft of floris wind model

a5b1ef6

added is_day variable to openmeteo downloads

0e99c4e

Merge branch 'develop' of github.com:NREL/H2Integrate into floris

e135373

added cache to floris model

7cc0eeb

added cache to floris model

ae6d5bb

made cache file utility method

db50a0f

updated floris to use cache filename making utility

d1c766c

Merge branch 'develop' of github.com:NREL/H2Integrate into floris

6ed49c0

elenya-grant added the in progress label Nov 20, 2025

elenya-grant added 8 commits November 20, 2025 16:34

added docstring to new utility method and updates to floris wrapper

3284f2c

added floris files to the library

37a8eff

added draft files for floris example

c3eb417

added floris to supported models

73e53c0

added test for floris

cbacf7e

added in wind resource tools

ebddbe5

added resource parse methods into floris wrapper

fc53ff1

updates to floris and resource tools

c8ed08b

elenya-grant mentioned this pull request Nov 26, 2025

Preprocessing Tool for Turbine Model Files #379

Merged

32 tasks

elenya-grant added 5 commits November 26, 2025 15:16

added docstrings and added cache_dir as input to make_cache_hash_file…

04b9f1b

…name

bugfixes in floris model, updated floris example, added tests for flo…

985873e

…ris example

minor update to example tech config

913e659

Merge remote-tracking branch 'h2i_upstream/develop' into floris

3245738

added comments and updated changelog

a6786a1

elenya-grant marked this pull request as ready for review December 1, 2025 23:32

elenya-grant requested review from genevievestarke, jaredthomas68, johnjasa and kbrunik December 1, 2025 23:32

added floris to technology overview

b90b25a

elenya-grant removed the in progress label Dec 2, 2025

elenya-grant added 3 commits January 6, 2026 10:47

added test for preprocessing turbine tools with floris

d1aae36

updated turb preprocessing doc page

099e7ba

fixed failing test

3bcfb98

elenya-grant added ready for review This PR is ready for input from folks and removed needs modifications This PR has been reviewed, at least partially, and is ready for PR author response labels Jan 6, 2026

elenya-grant requested review from genevievestarke, jaredthomas68 and johnjasa January 6, 2026 18:12

johnjasa approved these changes Jan 6, 2026

View reviewed changes

merged in develop

b2ac480

elenya-grant mentioned this pull request Jan 6, 2026

Add air density adjustment for elevation to FLORIS wrapper #439

Closed

elenya-grant added 3 commits January 6, 2026 15:33

added in air density adjustment and renamed operation model

5681f70

added test for air density adjustment in floris

d3fc28b

removed note about including air density adjustment

176e345

genevievestarke approved these changes Jan 8, 2026

View reviewed changes

jaredthomas68 requested changes Jan 8, 2026

View reviewed changes

elenya-grant added 4 commits January 9, 2026 09:53

updated wind resource units for is_day and added some tests for wind …

47e0fd0

…resource tools

bugfix and added test for weighted average wind speed

84d1302

draft stage of estimating wind speed using shear

50e2e4f

removed wind shear estimations

17d6ac6

elenya-grant mentioned this pull request Jan 9, 2026

Wind speed estimate at hub-height using shear #444

Open

updated test values for floris example test due to fig in weighted av…

ea5c3f4

…g resource data method

elenya-grant requested a review from jaredthomas68 January 9, 2026 20:12

jaredthomas68 approved these changes Jan 9, 2026

View reviewed changes

h2integrate/converters/wind/floris.py Show resolved Hide resolved

renamed floris example and updated relevant tests

f4f519d

elenya-grant merged commit cb539a7 into NatLabRockies:develop Jan 9, 2026
5 checks passed

elenya-grant mentioned this pull request Jan 16, 2026

Tests for wind performance models #246

Closed

		return rho


		def calculate_air_density_losses(elevation_m: float) -> float:

Added FLORIS wind plant model #372

Added FLORIS wind plant model #372

Uh oh!

Conversation

elenya-grant commented Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Added FLORIS wind plant model

Type of Contribution

General PR Checklist

New Technology Checklist

Related issues

Impacted areas of the software

Modified files

New files

Additional supporting information

Test results, if applicable

Uh oh!

review-notebook-app bot commented Jan 6, 2026

Uh oh!

johnjasa left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

johnjasa Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elenya-grant commented Jan 6, 2026

Uh oh!

genevievestarke left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jaredthomas68 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elenya-grant commented Jan 9, 2026

Uh oh!

jaredthomas68 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

elenya-grant commented Nov 20, 2025 •

edited

Loading

johnjasa Jan 6, 2026 •

edited

Loading