Change to US-English (initialise --> initialize)

This is to standardize the language in the windpowerlib. US-English is
chosen as python libs are using it for example pandas: tz_localize()

Author: SabineHaas

example/basic_example.ipynb

@@ -74,11 +74,11 @@ def get_weather_data(filename='weather.csv', **kwargs):
     return weather_df
 
 
-def initialise_wind_turbines():
+def initialize_wind_turbines():
     r"""
-    Initialises two :class:`~.wind_turbine.WindTurbine` objects.
+    Initializes two :class:`~.wind_turbine.WindTurbine` objects.
 
-    Function shows two ways to initialise a WindTurbine object. You can either
+    Function shows two ways to initialize a WindTurbine object. You can either
     specify your own turbine, as done below for 'myTurbine', or fetch power
     and/or power coefficient curve data from data files provided by the
     windpowerlib, as done for the 'enerconE126'.
@@ -106,7 +106,7 @@ def initialise_wind_turbines():
                       0.0, 26.0, 180.0, 1500.0, 3000.0, 3000.0]],  # in W
                   'wind_speed': [0.0, 3.0, 5.0, 10.0, 15.0, 25.0]})  # in m/s
     }
-    # initialise WindTurbine object
+    # initialize WindTurbine object
     my_turbine = WindTurbine(**myTurbine)
 
     # specification of wind turbine where power curve is provided
@@ -118,7 +118,7 @@ def initialise_wind_turbines():
         'rotor_diameter': 127,  # in m
         'fetch_curve': 'power_curve'  # fetch power curve
     }
-    # initialise WindTurbine object
+    # initialize WindTurbine object
     e126 = WindTurbine(**enerconE126)
 
     return my_turbine, e126
@@ -147,7 +147,7 @@ def calculate_power_output(weather, my_turbine, e126):
     """
 
     # power output calculation for my_turbine
-    # initialise ModelChain with default parameters and use run_model method
+    # initialize ModelChain with default parameters and use run_model method
     # to calculate power output
     mc_my_turbine = ModelChain(my_turbine).run_model(weather)
     # write power output timeseries to WindTurbine object
@@ -168,7 +168,7 @@ def calculate_power_output(weather, my_turbine, e126):
         'density_correction': True,  # False (default) or True
         'obstacle_height': 0,  # default: 0
         'hellman_exp': None}  # None (default) or None
-    # initialise ModelChain with own specifications and use run_model method
+    # initialize ModelChain with own specifications and use run_model method
     # to calculate power output
     mc_e126 = ModelChain(e126, **modelchain_data).run_model(weather)
     # write power output time series to WindTurbine object
@@ -233,7 +233,7 @@ def run_basic_example():
 
     """
     weather = get_weather_data('weather.csv')
-    my_turbine, e126 = initialise_wind_turbines()
+    my_turbine, e126 = initialize_wind_turbines()
     calculate_power_output(weather, my_turbine, e126)
     plot_or_print(my_turbine, e126)
 

example/basic_example.py

@@ -64,7 +64,7 @@
     "weather = basic_example.get_weather_data('weather.csv')\n",
     "print(weather[['wind_speed', 'temperature', 'pressure']][0:3])\n",
     "\n",
-    "# Initialize wind turbines\n",
+    "# Initialise wind turbines\n",
     "my_turbine, e126 = basic_example.initialise_wind_turbines()\n",
     "print()\n",
     "print('nominal power of my_turbine: {}'.format(my_turbine.nominal_power))"
@@ -135,7 +135,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Initialize wind turbine cluster\n",
+    "### Initialise wind turbine cluster\n",
     "\n",
     "Like for a wind farm for the initialization of a wind turbine cluster you can use a dictionary that contains the basic parameters. A wind turbine cluster is defined by its name, wind farms and optionally by its location."
    ]

example/further_example.ipynb

@@ -27,11 +27,11 @@
 logging.getLogger().setLevel(logging.DEBUG)
 
 
-def initialise_wind_farms(my_turbine, e126):
+def initialize_wind_farms(my_turbine, e126):
     r"""
-    Initialises two :class:`~.wind_farm.WindFarm` objects.
+    Initializes two :class:`~.wind_farm.WindFarm` objects.
 
-    This function shows how to initialise a WindFarm object. You need to
+    This function shows how to initialize a WindFarm object. You need to
     provide at least a name and a the wind farm's wind turbine fleet as done
     below for 'example_farm'. Optionally you can provide a wind farm efficiency
     (which can be constant or dependent on the wind speed) and coordinates as
@@ -61,7 +61,7 @@ def initialise_wind_farms(my_turbine, e126):
                                 'number_of_turbines': 3}
                                ]}
 
-    # initialise WindFarm object
+    # initialize WindFarm object
     example_farm = WindFarm(**example_farm_data)
 
     # specification of wind farm data (2) containing a wind farm efficiency
@@ -75,17 +75,17 @@ def initialise_wind_farms(my_turbine, e126):
         'efficiency': 0.9,
         'coordinates': [52.2, 13.1]}
 
-    # initialise WindFarm object
+    # initialize WindFarm object
     example_farm_2 = WindFarm(**example_farm_2_data)
 
     return example_farm, example_farm_2
 
 
-def initialise_wind_turbine_cluster(example_farm, example_farm_2):
+def initialize_wind_turbine_cluster(example_farm, example_farm_2):
     r"""
-    Initialises a :class:`~.wind_turbine_cluster.WindTurbineCluster` object.
+    Initializes a :class:`~.wind_turbine_cluster.WindTurbineCluster` object.
 
-    Function shows how to initialise a WindTurbineCluster object. In this case
+    Function shows how to initialize a WindTurbineCluster object. In this case
     the cluster only contains two wind farms.
 
     Parameters
@@ -106,7 +106,7 @@ def initialise_wind_turbine_cluster(example_farm, example_farm_2):
         'name': 'example_cluster',
         'wind_farms': [example_farm, example_farm_2]}
 
-    # initialise WindTurbineCluster object
+    # initialize WindTurbineCluster object
     example_cluster = WindTurbineCluster(**example_cluster_data)
 
     return example_cluster
@@ -137,7 +137,7 @@ class that provides all necessary steps to calculate the power output of a
     # set efficiency of example_farm to apply wake losses
     example_farm.efficiency = 0.9
     # power output calculation for example_farm
-    # initialise TurbineClusterModelChain with default parameters and use
+    # initialize TurbineClusterModelChain with default parameters and use
     # run_model method to calculate power output
     mc_example_farm = TurbineClusterModelChain(example_farm).run_model(weather)
     # write power output time series to WindFarm object
@@ -172,7 +172,7 @@ class that provides all necessary steps to calculate the power output of a
         'density_correction': True,  # False (default) or True
         'obstacle_height': 0,  # default: 0
         'hellman_exp': None}  # None (default) or None
-    # initialise TurbineClusterModelChain with own specifications and use
+    # initialize TurbineClusterModelChain with own specifications and use
     # run_model method to calculate power output
     mc_example_cluster = TurbineClusterModelChain(
             example_cluster, **modelchain_data).run_model(weather)
@@ -211,9 +211,9 @@ def run_example():
 
     """
     weather = basic_example.get_weather_data('weather.csv')
-    my_turbine, e126 = basic_example.initialise_wind_turbines()
-    example_farm, example_farm_2 = initialise_wind_farms(my_turbine, e126)
-    example_cluster = initialise_wind_turbine_cluster(example_farm,
+    my_turbine, e126 = basic_example.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)
     calculate_power_output(weather, example_farm, example_cluster)
     plot_or_print(example_farm, example_cluster)

example/further_example.py

@@ -14,7 +14,7 @@ class TestExamples:
     def test_basic_example_flh(self):
         # tests full load hours
         weather = be.get_weather_data('weather.csv')
-        my_turbine, e126 = be.initialise_wind_turbines()
+        my_turbine, e126 = be.initialize_wind_turbines()
         be.calculate_power_output(weather, my_turbine, e126)
 
         assert_allclose(1766.6870, (e126.power_output.sum() /
@@ -25,10 +25,10 @@ def test_basic_example_flh(self):
     def test_further_example_flh(self):
         # tests full load hours
         weather = be.get_weather_data('weather.csv')
-        my_turbine, e126 = be.initialise_wind_turbines()
-        example_farm, example_farm_2 = fe.initialise_wind_farms(my_turbine,
+        my_turbine, e126 = be.initialize_wind_turbines()
+        example_farm, example_farm_2 = fe.initialize_wind_farms(my_turbine,
                                                                 e126)
-        example_cluster = fe.initialise_wind_turbine_cluster(example_farm,
+        example_cluster = fe.initialize_wind_turbine_cluster(example_farm,
                                                              example_farm_2)
         fe.calculate_power_output(weather, example_farm, example_cluster)
         assert_allclose(1586.23527, (example_farm.power_output.sum() /