v3.1 #405

rafmudaf · 2022-03-31T23:06:53Z

Feature or improvement description
Merge develop to main for v3.1 release.

Additional supporting information
Proposed release notes are given below.

Release TODO

Update the version in
- README.rst
- docs/index.rst
- floris/VERSION
~~Verify readthedocs builds correctly~~ GH Pages is actually using the develop branch
Create a tag in the NREL/FLORIS repository

Release Notes

#358 Feature: add IEA 15MW turbine
#373 / #407 Add no_wake option to floris calculations
#384 Add normal vector to CutPlane to invert plot axis
#369 Redesign AEP calculation function
#385 Bug fix for yaw optimizer: revise verify_convergence to support multiple wind speeds
#382 Add cut out and default reference option
#388 Save yaw angles for reset in plane visualizations
#386 Documentation improvements
#393 Remove energy ratio tools in favor of FLASC
#308 Add UncertaintyInterface for modeling inflow wind direction uncertainty
#381 Fix for repeated calls to calculate_wake returning incorrect values
#387 Bug fix and formatting for legacy reader for FLORIS V2.4 input files
#395 / #406 Add 'none' submodel option for wake deflection, deficit and turbulence
#404 Add command line interface to the legacy input converter
#396 Adding the TurbOPark wake velocity deficit model
#408 Add GH Actions to run examples
#410 Create all Grid data at initialization

Feature: add IEA 15MW turbine

* Add no_wake option to calculate_wake() * Move no_wake up to floris_interface.py and separate initialize_domain() function in floris * updating tests to initialize domain * updating quality metrics to initialize domain Co-authored-by: bayc <christopher.j.bay@gmail.com>

* sketch in new AEP * sketch in new aep function * include a temporary no wake option * update AEP function to use no_wake * Update AEP example to use new function * Implement cut_in_wind_speed and cut_out_wind_speed functionalities. Also format freq vector in get_farm_AEP in FLORIS dimensions. * Quick bug fix and remove legacy _calc_one_AEP_case function * Update the example 07 for AEP calculations in new style * Significant simplications in get_farm_AEP function * Remove legacy functions for AEP calculation Co-authored-by: Bart Doekemeijer <bart.doekemeijer@nrel.gov>

) * Revise the verify_convergence functionality in the yaw optimization base class to support multiple wind speeds

* update cut-in and cutout region for each turbine yaml * add a check on reference height versus hub height and issue warning * allow -1 for reference height to mean use hub-height * Remove extrapolation, force definition in curve Co-authored-by: bayc <christopher.j.bay@gmail.com>

* Save yaw angles for reset in plane visualizations * Reset yaw angles through calculate_wake

* Include notebook as md * Update README and docs to reflect v3 release * Clarify points in the intro guide * Clarify legacy vs new docs * Add git / GitHub interaction guidelines

* Delete energy ratio tools * Remove references to energy ratio tools Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>

…ty (#308) * Implement uncertainty modeling in FLORIS v3.0 in vectorized format. Uncertainty is now included as a wrapper around the regular `FlorisInterface` object. * Add example demonstrating how to include uncertainty in wind farm simulations * Implement copy feature in `FlorisInterface` * Generalize yaw optimization compatibility with both `FlorisInterface` and `UncertaintyInterface`. Also fix bug in yaw optimizer when min/max yaw angle is an int. * Add option in `UncertaintyInterface` to fix the yaw angles in the inertial or relative frame * Remove `yaw_std` and update documentation Co-authored-by: paulf81 <paul.fleming@nrel.gov>

…381) * adding _sorted versions of variables (grid, farm, and flow field) * updating tests to use _sorted variables Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>

…387) * Move legacy input reader to separate tool and apply bug fix to work with recent changes in turbine_types * Add an example to demonstrate legacy input reader * Remove examples for legacy input reader. Add a __main__ script to the legacy reader file as an example to demonstrate file v2->v3 conversion.

#395) * Add 'none' submodel for deflection, deficit and turbulence * Add INFO and WARNINGs for 'none' option * Change warning message to error message if nonzero yaw angles are provided while deflection model is 'none' * Delete example yaml file and example script

* Move legacy input reader to separate tool and apply bug fix to work with recent changes in turbine_types * Add an example to demonstrate legacy input reader * Remove examples for legacy input reader. Add a __main__ script to the legacy reader file as an example to demonstrate file v2->v3 conversion. * Improve the CLI for input converter Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>

* adding turbopark model, solver, and input file Co-authored-by: Paul <paul.fleming@nrel.gov> Co-authored-by: Rafael M Mudafort <rafael.mudafort@nrel.gov>

bayc · 2022-04-01T17:08:48Z

@rafmudaf We should probably add tests for the none configurations, yea? The missing _sorted versions may have been caught with a test.

bayc · 2022-04-01T19:18:51Z

@rafmudaf I made an attempt at defining some tests for the "none" models, although I just realized I forgot about the wake_turbulence "none" model. If you can look at the tests, and this form makes sense, then we can add one for the wake_turbulence "none" model as well.

rafmudaf · 2022-04-01T20:37:18Z

I think what you're intending to do in the unit test should go into a None-model regression test. It's also not a bad idea to have unit-level tests for the model functions, but that would look different in that we would try to get as close to testing only the model.function() as possible and we might throw lots of unphysical numbers at the model to test for robustness. A regression test here would check that the correct form of the grid variables and flow field variables have been initialized and are used correctly.

Bartdoekemeijer · 2022-04-01T21:28:53Z

examples/inputs/turbopark.yaml

+
+logging:
+  console:
+    enable: false


This is false while for all others its true by default. Shall we update it to true for consistency between input files?

Bartdoekemeijer · 2022-04-01T22:11:34Z

Thanks for opening this PR, @rafmudaf!

I'm finding that 00_getting_started.ipynb and 07_calc_aep_from_rose.py no longer work. All the other examples work fine, and the UncertaintyInterface and none submodels work well too. Could someone verify examples 00 and 07 on their machine?

paulf81 · 2022-04-04T21:34:21Z

hi @Bartdoekemeijer thanks for checking, can confirm that both of these fail on my (mac) machine too.

For the case of example 7, the issue seems to arise from the no_wake call:

Farm AEP (with cut_in/out specified): 57.895 GWh
Traceback (most recent call last):
  File "/Users/pfleming/Desktop/git_tools/floris/examples/07_calc_aep_from_rose.py", line 84, in <module>
    aep_no_wake = fi.get_farm_AEP(freq, no_wake=True)
  File "/Users/pfleming/Desktop/git_tools/floris/floris/tools/floris_interface.py", line 692, in get_farm_AEP
    farm_power[:, conditions_to_evaluate] = self.get_farm_power()
  File "/Users/pfleming/Desktop/git_tools/floris/floris/tools/floris_interface.py", line 607, in get_farm_power
    turbine_powers = self.get_turbine_powers()
  File "/Users/pfleming/Desktop/git_tools/floris/floris/tools/floris_interface.py", line 549, in get_turbine_powers
    turbine_type_map=self.floris.farm.turbine_type_map,
AttributeError: 'Farm' object has no attribute 'turbine_type_map'

Where line 84 is:

aep_no_wake = fi.get_farm_AEP(freq, no_wake=True)

In the notebook, I'm having trouble trying to display the 3D grid, maybe the structure of grid has changed?

rafmudaf · 2022-04-04T22:21:32Z

I think the problem in the notebook is that grid.x doesn't exist at that point since this is before doing the computation; that is, grid.finalize() hasn't run so only grid.x_sorted exists at that point

rafmudaf · 2022-04-04T23:01:01Z

I'm adding a GitHub Action to run the examples for each commit to check whether they run (not evaluating the results).

Bartdoekemeijer · 2022-04-04T23:31:10Z

I really like that idea, @rafmudaf! And thank you for rerunning those examples @paulf81. For 07_calc_aep_from_rose.py, the code seems to be missing self.floris.farm.turbine_type_map and a couple other variables. I'm opening a pull request now that solves the no_wake=True problems.

* Add None-model regression tests * Remove unused data in None prepare-functions

bayc · 2022-04-05T17:03:13Z

I really like that idea, @rafmudaf! And thank you for rerunning those examples @paulf81. For 07_calc_aep_from_rose.py, the code seems to be missing self.floris.farm.turbine_type_map and a couple other variables. I'm opening a pull request now that solves the no_wake=True problems.

Beyond x, y, z, and u, v, w, there are several other variables that now have _sorted versions, turbine_type_map being one of those. I'll look at the code to see if there is a proper way to initialize these values for the users before any calculation is done.

Add GH Action to ensure examples run

* Resolve issue with no_wake=True option * move no_wake check to steady_state_atmospheric_condition so finalize is run when no_wake is True * updating how no_wake is handled to have a dedicated calculate_no_wake method * Restore profiling infrastructure (was commented) * Update calculate_no_wake docstring Co-authored-by: bayc <christopher.j.bay@gmail.com> Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>

* Move grid.finalize into initialization * Update getting-started Notebook

paulf81 and others added 24 commits March 2, 2022 13:09

Add 15 MW yaml file

ccd44b8

Update check turbine example to compare cp/ct

468615d

Clip ct in nrel 5mw

18f4014

Update NREL 5MW model in tests

6b77ac7

Merge pull request #358 from paulf81/feature/add_15_mw

572fa34

Feature: add IEA 15MW turbine

Merge remote-tracking branch 'nrel/main' into develop

1ea8c15

Merge branch 'main' into develop

cb78086

Add normal vector to CutPlane to invert plot axis (#384)

6e4ef3f

Bug fix: revise verify_convergence to support multiple wind speeds (#385

f20dfc4

) * Revise the verify_convergence functionality in the yaw optimization base class to support multiple wind speeds

Save yaw angles for reset in plane visualizations (#388)

ee5424e

* Save yaw angles for reset in plane visualizations * Reset yaw angles through calculate_wake

Documentation improvements (#386)

444ac1e

* Include notebook as md * Update README and docs to reflect v3 release * Clarify points in the intro guide * Clarify legacy vs new docs * Add git / GitHub interaction guidelines

Remove energy ratio tools in favor of FLASC (#393)

5c386ec

* Delete energy ratio tools * Remove references to energy ratio tools Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>

SOSFS: fix model string typo

1f37f12

Merge branch 'main' into develop

380a0ab

Fix for repeated calls to calculate_wake returning incorrect values. (#…

2341a1b

…381) * adding _sorted versions of variables (grid, farm, and flow field) * updating tests to use _sorted variables Co-authored-by: Rafael M Mudafort <rafmudaf@gmail.com>

Adding the TurbOPark wake velocity deficit model (#396)

ba546fa

* adding turbopark model, solver, and input file Co-authored-by: Paul <paul.fleming@nrel.gov> Co-authored-by: Rafael M Mudafort <rafael.mudafort@nrel.gov>

Update version to 3.1

543b5be

rafmudaf self-assigned this Mar 31, 2022

rafmudaf added the v3 Label to denote focus on v3 label Mar 31, 2022

rafmudaf added this to the v3.1.0 milestone Mar 31, 2022

rafmudaf requested review from paulf81, Bartdoekemeijer and bayc March 31, 2022 23:15

github-pages bot temporarily deployed to github-pages April 1, 2022 17:04 Inactive

bayc added 2 commits April 1, 2022 13:15

add _sorted variables to "none" models

d9bceee

add tests for "none" models

eef4286

github-pages bot temporarily deployed to github-pages April 1, 2022 19:16 Inactive

rafmudaf mentioned this pull request Apr 1, 2022

Add tests for None models #406

Merged

Bartdoekemeijer reviewed Apr 1, 2022

View reviewed changes

Bartdoekemeijer mentioned this pull request Apr 4, 2022

Bugfix: Resolve issues with no_wake=True #407

Merged

rafmudaf mentioned this pull request Apr 5, 2022

Add GH Action to ensure examples run #408

Merged

Swap None-model unit tests for regression tests (#406)

9079c45

* Add None-model regression tests * Remove unused data in None prepare-functions

github-pages bot temporarily deployed to github-pages April 5, 2022 15:46 Inactive

rafmudaf added 4 commits April 5, 2022 17:41

Add GH Action to ensure examples run

3c0f2dc

Include Jupyter notebooks in examples Action

c43913f

Use Python stdlib time in notebook demo

e9c5a19

Merge pull request #408 from rafmudaf/test_examples

524acfc

Add GH Action to ensure examples run

github-pages bot temporarily deployed to github-pages April 5, 2022 22:43 Inactive

github-pages bot temporarily deployed to github-pages April 6, 2022 16:14 Inactive

rafmudaf mentioned this pull request Apr 6, 2022

Create all Grid data at initialization #410

Merged

Create all Grid data at initialization (#410)

ca6362f

* Move grid.finalize into initialization * Update getting-started Notebook

github-pages bot temporarily deployed to github-pages April 6, 2022 20:46 Inactive

rafmudaf merged commit a23241b into main Apr 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

v3.1 #405

v3.1 #405

rafmudaf commented Mar 31, 2022 •

edited

Loading

bayc commented Apr 1, 2022 •

edited

Loading

bayc commented Apr 1, 2022

rafmudaf commented Apr 1, 2022

Bartdoekemeijer Apr 1, 2022 •

edited

Loading

Bartdoekemeijer commented Apr 1, 2022

paulf81 commented Apr 4, 2022

rafmudaf commented Apr 4, 2022 •

edited

Loading

rafmudaf commented Apr 4, 2022

Bartdoekemeijer commented Apr 4, 2022

bayc commented Apr 5, 2022

v3.1 #405

v3.1 #405

Conversation

rafmudaf commented Mar 31, 2022 • edited Loading

Release TODO

Release Notes

bayc commented Apr 1, 2022 • edited Loading

bayc commented Apr 1, 2022

rafmudaf commented Apr 1, 2022

Bartdoekemeijer Apr 1, 2022 • edited Loading

Choose a reason for hiding this comment

Bartdoekemeijer commented Apr 1, 2022

paulf81 commented Apr 4, 2022

rafmudaf commented Apr 4, 2022 • edited Loading

rafmudaf commented Apr 4, 2022

Bartdoekemeijer commented Apr 4, 2022

bayc commented Apr 5, 2022

rafmudaf commented Mar 31, 2022 •

edited

Loading

bayc commented Apr 1, 2022 •

edited

Loading

Bartdoekemeijer Apr 1, 2022 •

edited

Loading

rafmudaf commented Apr 4, 2022 •

edited

Loading