Remove Dummy turbine and download weather

Author: uvchik

example/modelchain_example.py

@@ -15,20 +15,16 @@
 """
 import os
 import pandas as pd
+import logging
+import requests
+from windpowerlib import ModelChain
+from windpowerlib import WindTurbine
 
 try:
     from matplotlib import pyplot as plt
 except ImportError:
     plt = None
 
-from windpowerlib import ModelChain
-from windpowerlib import WindTurbine
-
-# You can use the logging package to get logging messages from the windpowerlib
-# Change the logging level if you want more or less messages
-import logging
-logging.getLogger().setLevel(logging.DEBUG)
-
 
 def get_weather_data(filename='weather.csv', **kwargs):
     r"""
@@ -65,11 +61,16 @@ def get_weather_data(filename='weather.csv', **kwargs):
     """
 
     if "datapath" not in kwargs:
-        kwargs["datapath"] = os.path.join(
-            os.path.split(os.path.dirname(__file__))[0], "example"
-        )
+        kwargs["datapath"] = os.path.dirname(__file__)
+
     file = os.path.join(kwargs["datapath"], filename)
 
+    if not os.path.isfile(file):
+        logging.debug("Download weather data for example.")
+        req = requests.get("https://osf.io/59bqn/download")
+        with open(file, "wb") as fout:
+            fout.write(req.content)
+
     # read csv file
     weather_df = pd.read_csv(
         file,
@@ -136,22 +137,10 @@ def initialize_wind_turbines():
     # initialize WindTurbine object
     my_turbine = WindTurbine(**my_turbine)
 
-    # specification of wind turbine where power coefficient curve and nominal
-    # power is provided in an own csv file
-    csv_path = os.path.join(os.path.dirname(__file__), "data")
-    dummy_turbine = {
-        "turbine_type": "DUMMY 1",
-        "hub_height": 100,  # in m
-        "rotor_diameter": 70,  # in m
-        "path": csv_path,
-    }
-    # initialize WindTurbine object
-    dummy_turbine = WindTurbine(**dummy_turbine)
-
-    return my_turbine, e126, dummy_turbine
+    return my_turbine, e126
 
 
-def calculate_power_output(weather, my_turbine, e126, dummy_turbine):
+def calculate_power_output(weather, my_turbine, e126):
     r"""
     Calculates power output of wind turbines using the
     :class:`~.modelchain.ModelChain`.
@@ -172,8 +161,6 @@ def calculate_power_output(weather, my_turbine, e126, dummy_turbine):
     e126 : :class:`~.wind_turbine.WindTurbine`
         WindTurbine object with power curve from the OpenEnergy Database
         turbine library.
-    dummy_turbine : :class:`~.wind_turbine.WindTurbine`
-        WindTurbine object with power coefficient curve from example file.
 
     """
 
@@ -209,14 +196,14 @@ def calculate_power_output(weather, my_turbine, e126, dummy_turbine):
     # power output calculation for example_turbine
     # own specification for 'power_output_model'
     mc_example_turbine = ModelChain(
-        dummy_turbine, power_output_model="power_coefficient_curve"
+        my_turbine, power_output_model="power_coefficient_curve"
     ).run_model(weather)
-    dummy_turbine.power_output = mc_example_turbine.power_output
+    my_turbine.power_output = mc_example_turbine.power_output
 
     return
 
 
-def plot_or_print(my_turbine, e126, dummy_turbine):
+def plot_or_print(my_turbine, e126):
     r"""
     Plots or prints power output and power (coefficient) curves.
 
@@ -227,23 +214,18 @@ def plot_or_print(my_turbine, e126, dummy_turbine):
     e126 : :class:`~.wind_turbine.WindTurbine`
         WindTurbine object with power curve from the OpenEnergy Database
         turbine library.
-    dummy_turbine : :class:`~.wind_turbine.WindTurbine`
-        WindTurbine object with power coefficient curve from example file.
-
     """
 
     # plot or print turbine power output
     if plt:
         e126.power_output.plot(legend=True, label='Enercon E126')
         my_turbine.power_output.plot(legend=True, label='myTurbine')
-        dummy_turbine.power_output.plot(legend=True, label='dummyTurbine')
         plt.xlabel('Time')
         plt.ylabel('Power in W')
         plt.show()
     else:
         print(e126.power_output)
         print(my_turbine.power_output)
-        print(dummy_turbine.power_output)
 
     # plot or print power curve
     if plt:
@@ -259,13 +241,6 @@ def plot_or_print(my_turbine, e126, dummy_turbine):
             plt.xlabel('Wind speed in m/s')
             plt.ylabel('Power in W')
             plt.show()
-        if dummy_turbine.power_coefficient_curve is not False:
-            dummy_turbine.power_coefficient_curve.plot(
-                x='wind_speed', y='value', style='*',
-                title='dummyTurbine power coefficient curve')
-            plt.xlabel('Wind speed in m/s')
-            plt.ylabel('Power coefficient')
-            plt.show()
     else:
         if e126.power_coefficient_curve is not False:
             print(e126.power_coefficient_curve)
@@ -278,10 +253,16 @@ def run_example():
     Runs the basic example.
 
     """
+    # You can use the logging package to get logging messages from the
+    # windpowerlib. Change the logging level if you want more or less messages:
+    # logging.DEBUG -> many messages
+    # logging.INFO -> few messages
+    logging.getLogger().setLevel(logging.DEBUG)
+
     weather = get_weather_data("weather.csv")
-    my_turbine, e126, dummy_turbine = initialize_wind_turbines()
-    calculate_power_output(weather, my_turbine, e126, dummy_turbine)
-    plot_or_print(my_turbine, e126, dummy_turbine)
+    my_turbine, e126 = initialize_wind_turbines()
+    calculate_power_output(weather, my_turbine, e126)
+    plot_or_print(my_turbine, e126)
 
 
 if __name__ == "__main__":

example/test_examples.py

@@ -18,8 +18,8 @@ class TestExamples:
     def test_modelchain_example_flh(self):
         # tests full load hours
         weather = mc_e.get_weather_data("weather.csv")
-        my_turbine, e126, dummy_turbine = mc_e.initialize_wind_turbines()
-        mc_e.calculate_power_output(weather, my_turbine, e126, dummy_turbine)
+        my_turbine, e126 = mc_e.initialize_wind_turbines()
+        mc_e.calculate_power_output(weather, my_turbine, e126)
 
         assert_allclose(
             2764.194772, (e126.power_output.sum() / e126.nominal_power), 0.01

example/turbine_cluster_modelchain_example.py

@@ -11,21 +11,15 @@
 SPDX-License-Identifier: MIT
 """
 import pandas as pd
-
-try:
-    from matplotlib import pyplot as plt
-except ImportError:
-    plt = None
-
+import logging
 from example import modelchain_example as mc_e
 from windpowerlib import WindFarm
 from windpowerlib import WindTurbineCluster
 from windpowerlib import TurbineClusterModelChain
-
-# You can use the logging package to get logging messages from the windpowerlib
-# Change the logging level if you want more or less messages
-import logging
-logging.getLogger().setLevel(logging.DEBUG)
+try:
+    from matplotlib import pyplot as plt
+except ImportError:
+    plt = None
 
 
 def initialize_wind_farms(my_turbine, e126):
@@ -151,7 +145,8 @@ class that provides all necessary steps to calculate the power output of a
     # power output calculation for turbine_cluster
     # own specifications for TurbineClusterModelChain setup
     modelchain_data = {
-        "wake_losses_model": "wind_farm_efficiency",  # 'dena_mean' (default), None,
+        "wake_losses_model": "wind_farm_efficiency",
+        # 'dena_mean' (default), None,
         # 'wind_farm_efficiency' or name
         #  of another wind efficiency curve
         #  see :py:func:`~.wake_losses.get_wind_efficiency_curve`
@@ -217,8 +212,14 @@ def run_example():
     Runs the example.
 
     """
+    # You can use the logging package to get logging messages from the
+    # windpowerlib. Change the logging level if you want more or less messages:
+    # logging.DEBUG -> many messages
+    # logging.INFO -> few messages
+    logging.getLogger().setLevel(logging.DEBUG)
+
     weather = mc_e.get_weather_data("weather.csv")
-    my_turbine, e126, dummy_turbine = mc_e.initialize_wind_turbines()
+    my_turbine, e126 = mc_e.initialize_wind_turbines()
     example_farm, example_farm_2 = initialize_wind_farms(my_turbine, e126)
     example_cluster = initialize_wind_turbine_cluster(
         example_farm, example_farm_2