Merge pull request #10 from NREL/develop

Merge develop master for version 1.1.0

Author: rafmudaf

README.rst

@@ -45,6 +45,9 @@ modeling and simulation tool for controls research are
 Citation
 ========
 
+.. image:: https://zenodo.org/badge/178914781.svg
+  :target: https://zenodo.org/badge/latestdoi/178914781
+
 If FLORIS played a role in your research, please cite it. This software can be
 cited as:
 

docs/_static/images/EnergyRatioLayout.png

@@ -88,7 +88,7 @@
     # "logo_name": True,
     "travis_button": True,
     "fixed_sidebar": True,
-    "github_user": "WISDEM",
+    "github_user": "NREL",
     "github_repo": "FLORIS",
     "sidebar_width": '375px',
     "page_width": '75%',

docs/conf.py

@@ -55,6 +55,9 @@ modeling and simulation tool for controls research are
 Citation
 ========
 
+.. image:: https://zenodo.org/badge/178914781.svg
+  :target: https://zenodo.org/badge/latestdoi/178914781
+
 If FLORIS played a role in your research, please cite it. This software can be
 cited as:
 

docs/index.rst

@@ -4,6 +4,35 @@ Change Log
 For download and installation instructions, see the
 :ref:`installation <installation>` section.
 
+v1.1.0
+======
+Released on 2019-05-31
+
+Visualization:
+
+- Add quiver plot function to show in-plane flows
+- Adds example 7 which visualizes curl in the wake
+
+Energy Ratio
+
+- Adds additional functions for computing energy ratio as a function of wind
+  speed
+- Adds an example which uses FLORIS simulation to demonstrate the energy ratio
+  methods
+
+Wake Model changes
+
+- Set deflection multiplier in gauss deflection to 1.2 (was 1.0) to better
+  match SOWFA and field results
+- Update regression test to match
+
+Small Changes
+
+- Removal of unnecessary imports in some files
+- Update of the CP/CT tables for example NREL 5MW ref to better model above
+  rated
+- Fix VEC3 print method to print ints without decimal values
+
 v1.0.0
 ======
 Released on 2019-05-07

docs/source/changelog.rst

@@ -12,9 +12,11 @@ to provide instruction on the use of most of the underlying codes.
     examples/example_0000.rst
     examples/example_0005.rst
     examples/example_0006.rst
+    examples/example_0007.rst
     examples/example_0010.rst
     examples/example_0015.rst
     examples/example_0020.rst
+    examples/example_0030.rst
 
 For questions not covered in the examples, or to request additional examples, please first search for or 
 submit your questions to stackoverflow.com using the tag FLORIS.  Additionally you can contact 

docs/source/examples.rst

@@ -0,0 +1,40 @@
+example_0007_vis_curl.py
+========================
+
+The code for this example can be found here: `example_0007_vis_curl.py
+<https://github.com/NREL/floris/blob/develop/examples/example_0007_vis_curl.py>`_
+
+This example demonstrates visualizing in-plane flow using a quiver plot.  Further, to facilitate
+more elaborate 3-dimensional visulizations with a program such as paraview or vapor, the flow data
+is exported to VTK.  
+
+First, to ensure the presense of in plane flows, the curl model is selected
+
+::
+
+        # Initialize the FLORIS interface fi
+        fi = wfct.floris_utilities.FlorisInterface("example_input.json")
+
+        # Change the model to curl
+        fi.floris.farm.set_wake_model('curl')
+
+
+
+This block of code shows the methods for visualizing in-plane flows on a cut plane 5D behind the turbine
+
+::
+
+        # Get the vertical cut through and visualize
+        cp = wfct.cut_plane.CrossPlane(fi.get_flow_data(),5*D)
+        fig, ax = plt.subplots(figsize=(10,10))
+        wfct.visualization.visualize_cut_plane(cp, ax=ax,minSpeed=6.0,maxSpeed=8)
+        wfct.visualization.visualize_quiver(cp,ax=ax,downSamp=2)
+
+The flow data itself is cropped for size and exported to vtk in the following block
+
+::
+
+        #Save the flow data as vtk
+        flow_data = fi.get_flow_data()
+        flow_data = flow_data.crop(flow_data,[0,20*D],[-300,300],[50,300])
+        flow_data.save_as_vtk('for_3d_viz.vtk')

docs/source/examples/example_0007.rst

@@ -0,0 +1,49 @@
+example_0030_demo_energy_ratio.py
+======================================
+
+The code for this example can be found here: 
+`example_0030_demo_energy_ratio.py
+<https://github.com/NREL/floris/blob/develop/examples/example_0030_demo_energy_ratio.py>`_
+
+This example uses FLORIS to demonstrate the energy ratio method used in analyzing field campagin data.
+A version of this code is used for example in the paper:
+`Initial results from a field campaign of wake steering applied at a commercial wind farm – Part 1
+<https://www.wind-energ-sci.net/4/273/2019/wes-4-273-2019.html>`_
+
+The example sets up a FLORIS farm in which a simulated controller (which simply sets an upstream
+turbine to have a fixed 20 deg offset is tested).  The farm consists of a control turbine which implements
+the strategy, a downstream turbine effect by this change, and a reference turbine not-impacted.  The farm is shown here:
+
+.. image:: ../../_static/images/EnergyRatioLayout.png
+
+
+After setting the farm, the farm is simulated using random wind speed directions with the upstream turbine aligned (Baseline)
+or set to 20 degrees offset in yaw (controlled).  The power of the reference and test turbine are saved in arrays in this block
+for the baseline case:
+
+::
+
+    # Initialize the arrays for baseline
+    ref_pow_base = np.zeros(n_sim)
+    test_pow_base = np.zeros(n_sim)
+    ws_base = np.random.uniform(low=5,high=15.,size=n_sim)
+    wd_base = wd_var_scale * (np.random.rand(n_sim) - 0.5) + 270.
+
+    # Run the baseline
+    for i, (ws,wd) in enumerate(zip(ws_base,wd_base)):
+        fi.reinitialize_flow_field(wind_speed=ws, wind_direction=wd)
+        fi.calculate_wake()
+        turb_powers = fi.get_turbine_power()
+        ref_pow_base[i] = turb_powers[1] # The unaffacted second turbine
+        test_pow_base[i] = turb_powers[2] # The downstream turbine
+
+These saved arrays are then used to demonstrate the balanced energy ratio methods in the final block
+
+::
+
+    fig, axarr = plt.subplots(3,1,sharex=True,figsize=(10,10))
+
+    plot_energy_ratio(ref_pow_base,test_pow_base,ws_base,wd_base,
+                        ref_pow_con,test_pow_con,ws_con,wd_con,
+                        wd_bins, plot_simple=False, axarr=axarr, label_array=['Field Baseline', 'Field Controlled'],
+                        label_pchange='Field Gain' )

docs/source/examples/example_0030.rst

@@ -13,7 +13,6 @@
 
 import matplotlib.pyplot as plt
 import floris.tools as wfct
-from floris.utilities import Vec3
 
 # Initialize the FLORIS interface fi
 fi = wfct.floris_utilities.FlorisInterface("example_input.json")

examples/example_0000_open_and_vis_floris.py

@@ -15,7 +15,6 @@
 import floris.tools as wfct
 import floris.tools.visualization as vis
 import floris.tools.cut_plane as cp
-from floris.utilities import Vec3
 import numpy as np
 from mpl_toolkits.axes_grid1 import make_axes_locatable, axes_size