floris 4.2.1__tar.gz

floris-4.2.1/LICENSE.txt

@@ -0,0 +1,26 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, 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.

floris-4.2.1/PKG-INFO

@@ -0,0 +1,243 @@
+Metadata-Version: 2.1
+Name: floris
+Version: 4.2.1
+Summary: A controls-oriented engineering wake model.
+Author-email: Rafael Mudafort <rafael.mudafort@nrel.gov>, Paul Fleming <paul.fleming@nrel.gov>, "Michael (Misha) Sinner" <Michael.Sinner@nrel.gov>, Eric Simley <Eric.Simley@nrel.gov>, Christopher Bay <Christopher.Bay@nrel.gov>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2024, 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.
+        
+Project-URL: Homepage, https://github.com/NREL/floris
+Project-URL: Documentation, https://nrel.github.io/floris/
+Keywords: floris
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: attrs
+Requires-Dist: pyyaml~=6.0
+Requires-Dist: numexpr~=2.0
+Requires-Dist: numpy~=1.20
+Requires-Dist: scipy~=1.1
+Requires-Dist: matplotlib~=3.0
+Requires-Dist: pandas~=2.0
+Requires-Dist: shapely~=2.0
+Requires-Dist: coloredlogs~=15.0
+Requires-Dist: pathos~=0.3
+Provides-Extra: docs
+Requires-Dist: jupyter-book; extra == "docs"
+Requires-Dist: sphinx-book-theme; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Requires-Dist: sphinxcontrib-autoyaml; extra == "docs"
+Requires-Dist: sphinxcontrib.mermaid; extra == "docs"
+Provides-Extra: develop
+Requires-Dist: pytest; extra == "develop"
+Requires-Dist: pre-commit; extra == "develop"
+Requires-Dist: ruff; extra == "develop"
+Requires-Dist: isort; extra == "develop"
+
+# FLORIS Wake Modeling and Wind Farm Controls Software
+
+FLORIS is a controls-focused wind farm simulation software incorporating
+steady-state engineering wake models into a performance-focused Python
+framework. It has been in active development at NREL since 2013 and the latest
+release is [FLORIS v4.2.1](https://github.com/NREL/floris/releases/latest).
+Online documentation is available at https://nrel.github.io/floris.
+
+The software is in active development and engagement with the development team
+is highly encouraged. If you are interested in using FLORIS to conduct studies
+of a wind farm or extending FLORIS to include your own wake model, please join
+the conversation in [GitHub Discussions](https://github.com/NREL/floris/discussions/)!
+
+## Installation
+
+**WARNING:**
+Support for python version 3.8 will be dropped in FLORIS v4.3. See [Installation documentation](https://nrel.github.io/floris/installation.html#installation) for details.
+
+**If upgrading from a previous version, it is recommended to install FLORIS v4 into a new virtual environment**.
+If you intend to use [pyOptSparse](https://mdolab-pyoptsparse.readthedocs-hosted.com/en/latest/) with FLORIS,
+it is recommended to install that package first before installing FLORIS.
+
+FLORIS can be installed by downloading the source code or via the PyPI
+package manager with `pip`.
+
+The simplest method is with `pip` by using this command:
+
+```bash
+pip install floris
+```
+
+Developers and anyone who intends to inspect the source code
+can install FLORIS by downloading the git repository
+from GitHub with ``git`` and use ``pip`` to locally install it.
+It is highly recommended to use a Python virtual environment manager
+such as [conda](https://docs.conda.io/en/latest/miniconda.html)
+in order to maintain a clean and sandboxed environment. The following
+commands in a terminal or shell will download and install FLORIS.
+
+```bash
+    # Download the source code from the `main` branch
+    git clone -b main https://github.com/NREL/floris.git
+
+    # If using conda, be sure to activate your environment prior to installing
+    # conda activate <env name>
+
+    # If using pyOptSpare, install it first
+    conda install -c conda-forge pyoptsparse
+
+    # Install FLORIS
+    pip install -e floris
+```
+
+With both methods, the installation can be verified by opening a Python interpreter
+and importing FLORIS:
+
+```python
+>>> import floris
+>>> help(floris)
+
+Help on package floris:
+
+NAME
+    floris - # Copyright 2024 NREL
+
+PACKAGE CONTENTS
+    convert_floris_input_v3_to_v4
+    convert_turbine_v3_to_v4
+    core (package)
+    cut_plane
+    floris_model
+    flow_visualization
+    layout_visualization
+    logging_manager
+    optimization (package)
+    parallel_floris_model
+    turbine_library (package)
+    type_dec
+    uncertain_floris_model
+    utilities
+    version
+    wind_data
+
+VERSION
+    4.2.1
+
+FILE
+    ~/floris/floris/__init__.py
+```
+
+It is important to regularly check for new updates and releases as new
+features, improvements, and bug fixes will be issued on an ongoing basis.
+
+## Quick Start
+
+FLORIS is a Python package run on the command line typically by providing
+an input file with an initial configuration. It can be installed with
+```pip install floris``` (see [installation](https://nrel.github.io/floris/installation.html)).
+The typical entry point is
+[FlorisModel](https://nrel.github.io/floris/_autosummary/floris.floris_model.html)
+which accepts the path to the input file as an argument. From there,
+changes can be made to the initial configuration through the
+[FlorisModel.set](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.set)
+routine, and the simulation is executed with
+[FlorisModel.run](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.run).
+
+```python
+from floris import FlorisModel
+fmodel = FlorisModel("path/to/input.yaml")
+fmodel.set(
+    wind_directions=[i for i in range(10)],
+    wind_speeds=[8.0]*10,
+    turbulence_intensities=[0.06]*10
+)
+fmodel.run()
+```
+
+Finally, results can be analyzed via post-processing functions available within
+[FlorisModel](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel)
+such as
+- [FlorisModel.get_turbine_layout](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.get_turbine_layout)
+- [FlorisModel.get_turbine_powers](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.get_turbine_powers)
+- [FlorisModel.get_farm_AEP](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.get_farm_AEP)
+
+and in two visualization packages: [layoutviz](https://nrel.github.io/floris/_autosummary/floris.layout_visualization.html) and [flowviz](https://nrel.github.io/floris/_autosummary/floris.flow_visualization.html).
+A collection of examples describing the creation of simulations as well as
+analysis and post processing are included in the
+[repository](https://github.com/NREL/floris/tree/main/examples). Examples are also listed
+in the [online documentation](https://nrel.github.io/floris/examples/001_opening_floris_computing_power.html).
+
+## Engaging on GitHub
+
+FLORIS leverages the following GitHub features to coordinate support and development efforts:
+
+- [Discussions](https://github.com/NREL/floris/discussions): Collaborate to develop ideas for new use cases, features, and software designs, and get support for usage questions
+- [Issues](https://github.com/NREL/floris/issues): Report potential bugs and well-developed feature requests
+- [Projects](https://github.com/orgs/NREL/projects/96): Include current and future work on a timeline and assign a person to "own" it
+
+Generally, the first entry point for the community will be within one of the
+categories in Discussions.
+[Ideas](https://github.com/NREL/floris/discussions/categories/ideas) is a great spot to develop the
+details for a feature request. [Q&A](https://github.com/NREL/floris/discussions/categories/q-a)
+is where to get usage support.
+[Show and tell](https://github.com/NREL/floris/discussions/categories/show-and-tell) is a free-form
+space to show off the things you are doing with FLORIS.
+
+
+# License
+
+BSD 3-Clause License
+
+Copyright (c) 2024, 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.

floris-4.2.1/README.md

@@ -0,0 +1,175 @@
+# FLORIS Wake Modeling and Wind Farm Controls Software
+
+FLORIS is a controls-focused wind farm simulation software incorporating
+steady-state engineering wake models into a performance-focused Python
+framework. It has been in active development at NREL since 2013 and the latest
+release is [FLORIS v4.2.1](https://github.com/NREL/floris/releases/latest).
+Online documentation is available at https://nrel.github.io/floris.
+
+The software is in active development and engagement with the development team
+is highly encouraged. If you are interested in using FLORIS to conduct studies
+of a wind farm or extending FLORIS to include your own wake model, please join
+the conversation in [GitHub Discussions](https://github.com/NREL/floris/discussions/)!
+
+## Installation
+
+**WARNING:**
+Support for python version 3.8 will be dropped in FLORIS v4.3. See [Installation documentation](https://nrel.github.io/floris/installation.html#installation) for details.
+
+**If upgrading from a previous version, it is recommended to install FLORIS v4 into a new virtual environment**.
+If you intend to use [pyOptSparse](https://mdolab-pyoptsparse.readthedocs-hosted.com/en/latest/) with FLORIS,
+it is recommended to install that package first before installing FLORIS.
+
+FLORIS can be installed by downloading the source code or via the PyPI
+package manager with `pip`.
+
+The simplest method is with `pip` by using this command:
+
+```bash
+pip install floris
+```
+
+Developers and anyone who intends to inspect the source code
+can install FLORIS by downloading the git repository
+from GitHub with ``git`` and use ``pip`` to locally install it.
+It is highly recommended to use a Python virtual environment manager
+such as [conda](https://docs.conda.io/en/latest/miniconda.html)
+in order to maintain a clean and sandboxed environment. The following
+commands in a terminal or shell will download and install FLORIS.
+
+```bash
+    # Download the source code from the `main` branch
+    git clone -b main https://github.com/NREL/floris.git
+
+    # If using conda, be sure to activate your environment prior to installing
+    # conda activate <env name>
+
+    # If using pyOptSpare, install it first
+    conda install -c conda-forge pyoptsparse
+
+    # Install FLORIS
+    pip install -e floris
+```
+
+With both methods, the installation can be verified by opening a Python interpreter
+and importing FLORIS:
+
+```python
+>>> import floris
+>>> help(floris)
+
+Help on package floris:
+
+NAME
+    floris - # Copyright 2024 NREL
+
+PACKAGE CONTENTS
+    convert_floris_input_v3_to_v4
+    convert_turbine_v3_to_v4
+    core (package)
+    cut_plane
+    floris_model
+    flow_visualization
+    layout_visualization
+    logging_manager
+    optimization (package)
+    parallel_floris_model
+    turbine_library (package)
+    type_dec
+    uncertain_floris_model
+    utilities
+    version
+    wind_data
+
+VERSION
+    4.2.1
+
+FILE
+    ~/floris/floris/__init__.py
+```
+
+It is important to regularly check for new updates and releases as new
+features, improvements, and bug fixes will be issued on an ongoing basis.
+
+## Quick Start
+
+FLORIS is a Python package run on the command line typically by providing
+an input file with an initial configuration. It can be installed with
+```pip install floris``` (see [installation](https://nrel.github.io/floris/installation.html)).
+The typical entry point is
+[FlorisModel](https://nrel.github.io/floris/_autosummary/floris.floris_model.html)
+which accepts the path to the input file as an argument. From there,
+changes can be made to the initial configuration through the
+[FlorisModel.set](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.set)
+routine, and the simulation is executed with
+[FlorisModel.run](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.run).
+
+```python
+from floris import FlorisModel
+fmodel = FlorisModel("path/to/input.yaml")
+fmodel.set(
+    wind_directions=[i for i in range(10)],
+    wind_speeds=[8.0]*10,
+    turbulence_intensities=[0.06]*10
+)
+fmodel.run()
+```
+
+Finally, results can be analyzed via post-processing functions available within
+[FlorisModel](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel)
+such as
+- [FlorisModel.get_turbine_layout](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.get_turbine_layout)
+- [FlorisModel.get_turbine_powers](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.get_turbine_powers)
+- [FlorisModel.get_farm_AEP](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.get_farm_AEP)
+
+and in two visualization packages: [layoutviz](https://nrel.github.io/floris/_autosummary/floris.layout_visualization.html) and [flowviz](https://nrel.github.io/floris/_autosummary/floris.flow_visualization.html).
+A collection of examples describing the creation of simulations as well as
+analysis and post processing are included in the
+[repository](https://github.com/NREL/floris/tree/main/examples). Examples are also listed
+in the [online documentation](https://nrel.github.io/floris/examples/001_opening_floris_computing_power.html).
+
+## Engaging on GitHub
+
+FLORIS leverages the following GitHub features to coordinate support and development efforts:
+
+- [Discussions](https://github.com/NREL/floris/discussions): Collaborate to develop ideas for new use cases, features, and software designs, and get support for usage questions
+- [Issues](https://github.com/NREL/floris/issues): Report potential bugs and well-developed feature requests
+- [Projects](https://github.com/orgs/NREL/projects/96): Include current and future work on a timeline and assign a person to "own" it
+
+Generally, the first entry point for the community will be within one of the
+categories in Discussions.
+[Ideas](https://github.com/NREL/floris/discussions/categories/ideas) is a great spot to develop the
+details for a feature request. [Q&A](https://github.com/NREL/floris/discussions/categories/q-a)
+is where to get usage support.
+[Show and tell](https://github.com/NREL/floris/discussions/categories/show-and-tell) is a free-form
+space to show off the things you are doing with FLORIS.
+
+
+# License
+
+BSD 3-Clause License
+
+Copyright (c) 2024, 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.

floris-4.2.1/floris/__init__.py

@@ -0,0 +1,24 @@
+
+from importlib.metadata import version
+from pathlib import Path
+
+
+__version__ = version("floris")
+
+
+from .floris_model import FlorisModel
+from .flow_visualization import (
+    plot_rotor_values,
+    visualize_cut_plane,
+    visualize_quiver,
+)
+from .heterogeneous_map import HeterogeneousMap
+from .par_floris_model import ParFlorisModel
+from .parallel_floris_model import ParallelFlorisModel
+from .uncertain_floris_model import ApproxFlorisModel, UncertainFlorisModel
+from .wind_data import (
+    TimeSeries,
+    WindRose,
+    WindRoseWRG,
+    WindTIRose,
+)

floris-4.2.1/floris/convert_floris_input_v3_to_v4.py

@@ -0,0 +1,93 @@
+import sys
+from pathlib import Path
+
+import yaml
+
+
+"""
+This script is intended to be called with an argument and converts a floris input
+yaml file specified for FLORIS v3 to one specified for FLORIS v4.
+
+Usage:
+python convert_floris_input_v3_to_v4.py <path/to/floris_input>.yaml
+
+The resulting floris input file is placed in the same directory as the original yaml,
+and is appended _v4.
+"""
+
+
+def ignore_include(loader, node):
+    # Parrot back the !include tag
+    return node.tag + " " + node.value
+
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        raise Exception(
+            "Usage: python convert_floris_input_v3_to_v4.py <path/to/floris_input>.yaml"
+        )
+
+    # Set the yaml loader to ignore the !include tag
+    yaml.SafeLoader.add_constructor("!include", ignore_include)
+
+    input_yaml = sys.argv[1]
+
+    # Handling the path and new filename
+    input_path = Path(input_yaml)
+    split_input = input_path.parts
+    [filename_v3, extension] = split_input[-1].split(".")
+    filename_v4 = filename_v3 + "_v4"
+    split_output = list(split_input[:-1]) + [filename_v4 + "." + extension]
+    output_path = Path(*split_output)
+
+    # Load existing v3 model
+    with open(input_yaml, "r") as file:
+        v3_floris_input_dict = yaml.safe_load(file)
+    v4_floris_input_dict = v3_floris_input_dict.copy()
+
+    # Change turbulence_intensity field to turbulence_intensities as list
+    if "turbulence_intensities" in v3_floris_input_dict["flow_field"]:
+        if "turbulence_intensity" in v3_floris_input_dict["flow_field"]:
+            del v4_floris_input_dict["flow_field"]["turbulence_intensity"]
+    elif "turbulence_intensity" in v3_floris_input_dict["flow_field"]:
+        v4_floris_input_dict["flow_field"]["turbulence_intensities"] = [
+            v3_floris_input_dict["flow_field"]["turbulence_intensity"]
+        ]
+        del v4_floris_input_dict["flow_field"]["turbulence_intensity"]
+
+    # Change multidim_cp_ct velocity model to gauss
+    if v3_floris_input_dict["wake"]["model_strings"]["velocity_model"] == "multidim_cp_ct":
+        print(
+            "multidim_cp_ct velocity model specified. Changing to gauss, "
+            + "but note that other velocity models are also compatible with multidimensional "
+            + "turbines in FLORIS v4. "
+            + "You will also need to convert your multidimensional turbine yaml files and their "
+            + "corresponding power/thrust csv files to be compatible with FLORIS v4 and to reflect "
+            + " the absolute power curve, rather than the power coefficient curve."
+        )
+        v4_floris_input_dict["wake"]["model_strings"]["velocity_model"] = "gauss"
+
+    # Add enable_active_wake_mixing field
+    v4_floris_input_dict["wake"]["enable_active_wake_mixing"] = False
+
+    # Write the new v4 model to a new file, note that the in order to ignore the !include tag
+    # it is wrapped in single quotes by the ignore include/load/dump sequence and these will
+    # need to be removed in the next block of code
+    yaml.dump(v4_floris_input_dict, open(output_path, "w"), sort_keys=False)
+
+    # Open the output file and loop through line by line
+    # if a line contains the substring !include, then strip all
+    # occurrences of ' from the line to remove the extra single quotes
+    # added by the ignore include/load/dump sequence
+    temp_output_path = output_path.with_name("temp.yaml")
+    with open(temp_output_path, "w") as file:
+        with open(output_path, "r") as f:
+            for line in f:
+                if "!include" in line:
+                    line = line.replace("'", "")
+                file.write(line)
+
+    # Move the temp file to the output file
+    temp_output_path.replace(output_path)
+
+    print(output_path, "created.")

floris-4.2.1/floris/convert_turbine_v3_to_v4.py

@@ -0,0 +1,86 @@
+
+import sys
+from pathlib import Path
+
+from floris.turbine_library import build_cosine_loss_turbine_dict, check_smooth_power_curve
+from floris.utilities import load_yaml
+
+
+"""
+This script is intended to be called with an argument and converts a turbine
+yaml file specified for FLORIS v3 to one specified for FLORIS v4.
+
+Usage:
+python convert_turbine_v3_to_v4.py <path/to/turbine>.yaml
+
+The resulting turbine is placed in the same directory as the original yaml,
+and is appended _v4.
+"""
+
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        raise Exception("Usage: python convert_turbine_v3_to_v4.py <path/to/turbine>.yaml")
+
+    input_yaml = sys.argv[1]
+
+    # Handling the path and new filename
+    input_path = Path(input_yaml)
+    split_input = input_path.parts
+    [filename_v3, extension] = split_input[-1].split(".")
+    filename_v4 = filename_v3 + "_v4"
+    split_output = list(split_input[:-1]) + [filename_v4+"."+extension]
+    output_path = Path(*split_output)
+
+    # Load existing v3 model
+    v3_turbine_dict = load_yaml(input_yaml)
+
+    # Split into components expected by build_turbine_dict
+    power_thrust_table = v3_turbine_dict["power_thrust_table"]
+    if "power_thrust_data_file" in power_thrust_table:
+        raise ValueError(
+            "Cannot convert multidimensional turbine model. Please manually update your "
+            + "turbine yaml. Note that the power_thrust_data_file csv needs to be updated to "
+            + "reflect the absolute power curve, rather than the power coefficient curve,"
+            + "and that `thrust` has been replaced by `thrust_coefficient`."
+        )
+    power_thrust_table["power_coefficient"] = power_thrust_table["power"]
+    power_thrust_table["thrust_coefficient"] = power_thrust_table["thrust"]
+    power_thrust_table.pop("power")
+    power_thrust_table.pop("thrust")
+
+    valid_properties = [
+        "generator_efficiency",
+        "hub_height",
+        "cosine_loss_exponent_yaw",
+        "cosine_loss_exponent_tilt",
+        "rotor_diameter",
+        "TSR",
+        "ref_air_density",
+        "ref_tilt"
+    ]
+
+    turbine_properties = {k:v for k,v in v3_turbine_dict.items() if k in valid_properties}
+    turbine_properties["ref_air_density"] = v3_turbine_dict["ref_density_cp_ct"]
+    turbine_properties["cosine_loss_exponent_yaw"] = v3_turbine_dict["pP"]
+    if "ref_tilt_cp_ct" in v3_turbine_dict:
+        turbine_properties["ref_tilt"] = v3_turbine_dict["ref_tilt_cp_ct"]
+    if "pT" in v3_turbine_dict:
+        turbine_properties["cosine_loss_exponent_tilt"] = v3_turbine_dict["pT"]
+
+    # Convert to v4 and print new yaml
+    v4_turbine_dict = build_cosine_loss_turbine_dict(
+        power_thrust_table,
+        v3_turbine_dict["turbine_type"],
+        output_path,
+        **turbine_properties
+    )
+
+    if not check_smooth_power_curve(
+        v4_turbine_dict["power_thrust_table"]["power"],
+        tolerance=0.001
+    ):
+        print(
+            "Non-smoothness detected in output power curve. ",
+            "Check above-rated power in generated v4 yaml file."
+        )