v4.2.1

Patch release for FLORIS v4.2. Includes various bug fixes (for wind rose plot, unnecessary warnings, and documentation building) as well as code development improvements (uniform testing across all supported python versions as well moving package requirements to pyproject.toml).

FLORIS v4.2 will be the last minor FLORIS version to support python version 3.8, which is at end-of-life.

What's Changed

• [BUGFIX] Address reference wind height warnings raised unnecessarily by @misi9170 in #1017
• Test on all supported Python versions by @rafmudaf in #1019
• Allow yaw optimization with disabled turbines (into develop) by @misi9170 in #1031
• Move all metadata to pyproject.toml by @paulf81 in #1026
• [BUGFIX] Reenable legend plotting on WindRose by @misi9170 in #1028
• Fix docs by @paulf81 in #1034
• Add warnings about dropping support for python 3.8 by @misi9170 in #1041
• [BUGFIX] Fix docs build 2 by @misi9170 in #1036
• FLORIS v4.2.1 by @misi9170 in #1029

Full Changelog: v4.2...v4.2.1

v2.5.2

Patch release for FLORIS v2

What's Changed

• Remove testing for Mac OS for FLORIS v2 by @misi9170 in #1020
• [BUGFIX] Correct grid coordinates for ngrid=1 by @gogannes in #1008

Full Changelog: v2.5.1...v2.5.2

v4.2

FLORIS v4.2 brings further new features to FLORIS, along with some performance enhancements and bug fixes/minor improvements

New features

• Implement TurbOPark as a Gaussian model by @JasperShell in #907
• Add WRG file support to FLORIS by @paulf81 in #919
• Add gridded layout optimizer by @misi9170 in #976
• New parallel option that is fully consistent with FlorisModel by @misi9170 in #982

Performance enhancements

• Speed up turbine loading operation by @misi9170 in #966

Functional enhancements

• make plotting the points of HetMap optional by @paulf81 in #957
• Add capabilities to parallel_floris_model by @paulf81 in #967
• Add features to UncertainFlorisModel by @paulf81 in #975
• Improved Wind Rose Plot (v2) by @paulf81 and @cfrontin in #969
• Add flow visualization to wake steering example by @misi9170 in #1006

Bug fixes

• [BUGFIX] Fix documentation examples build by @paulf81 in #960
• [BUGFIX] Fix bug in check_turbine example (not resetting operation) by @misi9170 in #962
• [BUGFIX] Gridded layout opt incorrectly generating spanning grid by @misi9170 in #984
• [BUGFIX] Control setpoints and wind data set on FlorisModel copied into ParFlorisModel by @misi9170 in #997
• Set ref wind height to -1 for turboparkgauss.yaml by @paulf81 in #999
• [BUGFIX] Warn users if the turbine_type is set without setting reference_wind_height by @misi9170 in #1000

New Contributors

• @JasperShell made their first contribution in #907
• @cfrontin made their first contribution in #969

Full Changelog: v4.1.1...v4.2

v4.1.1

What's Changed

• [BUGFIX] Fix wind rose plots by @paulf81 in #930
• Change docs image by @rafmudaf in #911
• Add link to GRS layout optimization paper by @misi9170 in #932
• Update names of WindRose resampling methods by @paulf81 in #933
• [BUGFIX] Fix turbine selector in random search layout optimizer by @misi9170 in #934
• Update coloredlogs requirement by @paulf81 in #939
• [BUGFIX] Create reproducible version of random search layout optimizer for testing by @misi9170 in #940
• [BUGFIX] Circular upsampling across wind directions by @paulf81 in #943
• Wind direction resampling 2 by @misi9170 in #946
• FLORIS v4.1.1 by @misi9170 in #945

Full Changelog: v4.1...v4.1.1

v4.1

What's Changed

• Add test for v3_to_v4 input file converters by @paulf81 in #880
• Peak shaving turbine operation model by @misi9170 in #888
• [BUGFIX] NoneWakeTurbulence returns zero (added) turbulence by @misi9170 in #894
• [BUGFIX] Include turbulence_intensities in turbine_previewer.py by @misi9170 in #900
• Ignore includes in v3->v4 conversions by @paulf81 in #904
• Expanded capabilities for heterogeneity by @paulf81 in #902
• Randomized layout optimization by @paulf81 in #697
• Add z/3d to HeterogeneousMap by @paulf81 in #915
• Fix typo in error message by @jaredthomas68 in #922
• FLORIS v4.1 by @misi9170 in #921

New Contributors

• @jaredthomas68 made their first contribution in #922

Full Changelog: v4.0.1...v4.1

v4.0.1

Bugfixes since the release of FLORIS v4.0

What's Changed

• [BUGFIX] Add enable_active_wake_mixing field to v3 to v4 documentation and conversion by @misi9170 in #878
• [BUGFIX] Update CubatureGrid for 4-dimensional data structures by @rafmudaf in #881
• [BUGFIX] Incorrect indexing to hub heights in Farm.coordinates() by @misi9170 in #890
• FLORIS v4.0.1 by @misi9170 in #891

Full Changelog: v4.0...v4.0.1

v4.0

FLORIS v4.0

FLORIS v4 brings significant additional flexibility to FLORIS while streamlining the underlying solving code.

For higher-level description of major changes, see #870.

What's Changed

• Convert core data structures and tools to use 4D arrays by @rafmudaf in #764
• Replace Cp with power in turbine definition and throughout FLORIS by @misi9170 in #765
• Update to more flexible turbine operation model definitions by @misi9170 in #770
• Update reference wind turbines in the default turbine library by @misi9170 in #771
• Adds classes to structure wind energy data for FLORIS by @paulf81 in #775
• Remove small variations in above rated power by @paulf81 in #784
• Convert turbulence intensity from single value to n_findex length array by @paulf81 in #782
• [BUGFIX] Bad import in convert_turbine_v3_to_v4.py by @misi9170 in #795
• Add de-rating op model by @paulf81 in #783
• Validate and test wind direction and wind speed by @paulf81 in #793
• Add support to shut off turbines by @paulf81 in #799
• Update yaw and layout optimization tools for 4D by @bayc in #790
• [BUGFIX] Correct condition when yaw_angles passed to TurboPark model by @misi9170 in #808
• Change from Apache to BSD 3-clause license by @paulf81 in #810
• [BUGFIX] Remove secondary effects from TurboPark model by @misi9170 in #813
• Clarify turbine definition terms by @misi9170 in #815
• Support multidimensional turbine definitions in all wake models by @misi9170 in #812
• Update multidim turbine files to use absolute turbine power by @bayc in #818
• Remove unused code from floris.tools and add tool reg tests by @bayc in #819
• Move FlorisInterface .reinitialize() / .calculate_wake() to .set() / .run() by @rafmudaf in #823
• Raise informative errors if v3 input files passed in by @misi9170 in #829
• Collect all layout visualization tools in FLORIS by @paulf81 in #805
• [Bugfix] Cast yaw angles to np.ndarray on set by @paulf81 in #828
• Update uncertainty interface to 4d, new API by @paulf81 in #821
• Drive layout optimizations using WindData objects by @paulf81 in #822
• Require TI must be length n_findex in core code by @paulf81 in #831
• Add TI as input for calculate plane functions by @rafmudaf in #837
• Rename floris.simulation, floris.tools to floris.core, floris by @rafmudaf in #830
• Add utilities for floris models by @paulf81 in #840
• Allow to fix yaw to nominal wind direction by @paulf81 in #850
• Add CSV reader for WindRose by @paulf81 in #848
• Save WindData onto FlorisModel and simplify post-run() calls by @misi9170 in #849
• Change power_thrust_model key to operation_model at the user level by @misi9170 in #859
• [BUGFIX] hardcoded reset to first turbine type in set_operation_model by @misi9170 in #856
• Enabling layout optimization for value by @ejsimley in #862
• [BUGFIX] set_operation_model ordering with layout by @misi9170 in #867
• Refactor examples by @paulf81 in #843
• Make set_operation method public by @misi9170 in #869
• Fixing datatype of value in WindData objects by @ejsimley in #872
• Add try/except to wind rose loader by @paulf81 in #874
• Clean up TODOs prior to v4 release by @misi9170 in #876
• Build out v4 documentation by @misi9170 in #860
• Add merge/reduce FLORIS objects by @paulf81 in #866
• Remove setpoints and wind condition specifics from calculate_XX_plane methods by @misi9170 in #868
• Update Empirical Gaussian default deflection_rate by @misi9170 in #875
• Improvements to WindRose resampling by @misi9170 in #857
• Add approximate FLORIS model by @paulf81 in #877
• FLORIS v4 by @misi9170 in #870

Full Changelog: v3.6...v4.0

v3.6

Final release of FLORIS v3 before releasing FLORIS v4 to the main branch. From this point onward, FLORIS v3 will be minimally maintained and support will switch to FLORIS v4.

What's Changed

• Add documentation for the release process by @rafmudaf in #727
• Catch documentation and examples errors by @rafmudaf in #736
• Fix errors in notebooks for online documentation by @rctredgold in #721
• Support relative paths in YAML configuration files by @RHammond2 in #739
• Use compatible-release specifier for dependency versions by @paulf81 in #748
• Fix path dependency in convert_to_path test by @RHammond2 in #749
• Improve attrs usage in simulation package by @rafmudaf in #750
• Bug fix: Enable mulit-dimensional turbines for turbine interactions by @RHammond2 in #754
• Fix the turbine.power function unit test by @paulf81 in #755
• Grid-class tidying by @rafmudaf in #751
• Fix issue with mutable default attributes by @paulf81 in #759
• Add utility to build turbine yaml from absolute power, thrust curves by @misi9170 in #729
• Clean up and align Turbine and TurbineMultiDim class architectures by @rafmudaf in #762
• Add capability to sample and plot velocity profiles by @vallbog in #699
• Add support for multiple turbine types in calculate_horizontal_plane_with_turbines() by @scottryn in #781
• [BUGFIX] Correct condition when yaw_angles passed to TurboPark model (version 3) by @misi9170 in #811
• [BUGFIX] Coordinates getter on Farm class by @misi9170 in #846
• Documentation improvements and fixes by @rafmudaf in #853
• FLORIS v3.6 by @misi9170 in #871

New Contributors

• @rctredgold made their first contribution in #721
• @vallbog made their first contribution in #699
• @scottryn made their first contribution in #781

Full Changelog: v3.5...v3.6

v2.5.1

What's Changed

• Bug fix: GCH effective yaw angle in FLORIS v2 by @fg320 in #734

New Contributors

• @fg320 made their first contribution in #734

v3.5

What's Changed

• Bug fix: erroneous rotation in turbine locations in horizontal flowfield plots by @Bartdoekemeijer in #663
• Feature: Add concurrent library to ParallelComputingInterface by @Bartdoekemeijer in #667
• Bug fix: Finalize Farm attributes by @rafmudaf in #665
• Performance Improvements and Code Simplification by @RHammond2 in #494
• Infrastructure updates by @rafmudaf in #677
• Bug fix: Add variable wind shear to GCH calculations by @fg320 in #679
• Enable heterogeneous inflows in yaw optimization routines by @misi9170 in #678
• Documentation fixes by @rafmudaf in #696
• Add geometric yaw code for rough yaw optimization (in layout optimization) by @misi9170 in #681
• Add example of larger floating farm with comparison to fixed-bottom. by @misi9170 in #695
• Address pandas 2.1.0 FutureWarning on wind rose plot by @pablo-benito in #710
• [Bugfix]: Update geometric yaw optimizer layout when called during layout optimization by @misi9170 in #706
• Allow switching on and off contour plot numerical labels at top level by @misi9170 in #719
• Feature: Add multidimensional Cp/Ct turbine definition support by @bayc in #711
• Update default parameters for the Empirical Gaussian model by @misi9170 in #723
• FLORIS v3.5 by @rafmudaf in #726

New Contributors

• @fg320 made their first contribution in #679

Full Changelog: v3.4.1...v3.5