HOPP v2.2.0

README.md

@@ -59,12 +59,12 @@ solar and storage.
     [https://developer.nrel.gov/signup/](https://developer.nrel.gov/signup/)
 
 
-7. To set up the `NREL_API_KEY` required for resource downloads, you can create an Environment Variable called 
-   `NREL_API_KEY`. Otherwise, you can keep the key in a new file called ".env" in the root directory of this project. 
+7. To set up the `NREL_API_KEY` and `NREL_API_EMAIL` required for resource downloads, you can create Environment Variables called `NREL_API_KEY` and `NREL_API_EMAIL`. Otherwise, you can keep the key in a new file called ".env" in the root directory of this project. 
 
     Create a file ".env" that contains the single line:
-     ```
+    ```
     NREL_API_KEY=key
+    NREL_API_EMAIL=your.name@email.com
     ```
 
 8. Verify setup by running tests:

docs/hopp/simulation/technologies/dispatch.rst

@@ -0,0 +1,50 @@
+.. _Dispatch:
+
+Dispatch Strategies
+===================
+
+These are the dispatch strategies that may be used for a standard HOPP simulation. Dispatch 
+settings can be defined through :class:`.HybridDispatchOptions`. 
+
+Storage Dispatch
+----------------
+
+.. toctree::
+    :maxdepth: 1
+
+    dispatch/power_storage/simple_battery_dispatch.rst
+    dispatch/power_storage/simple_battery_dispatch_heuristic.rst
+    dispatch/power_storage/heuristic_load_following_dispatch.rst
+    dispatch/power_storage/linear_voltage_convex_battery_dispatch.rst
+    dispatch/power_storage/linear_voltage_nonconvex_battery_dispatch.rst
+    dispatch/power_storage/one_cycle_battery_dispatch_heuristic.rst
+
+The above dispatch classes inherit from the :py:class:`.PowerStorageDispatch` class.
+
+.. toctree::
+    :maxdepth: 1
+
+    dispatch/power_storage/power_storage_dispatch.rst
+
+Technology Dispatch
+-------------------
+
+Dispatch classes are made for each technology where their specific components of the objectives,
+their parameters, and other technology specific dispatch properties are defined.
+
+.. toctree::
+    :maxdepth: 1
+
+    dispatch/power_sources/pv_dispatch.rst
+    dispatch/power_sources/wind_dispatch.rst
+    dispatch/power_sources/wave_dispatch.rst
+    dispatch/power_sources/trough_dispatch.rst
+    dispatch/power_sources/tower_dispatch.rst
+    dispatch/power_sources/csp_dispatch.rst
+
+The above technology classes inherit from the :py:class:`.PowerSourceDispatch` class.
+
+.. toctree::
+    :maxdepth: 1
+
+    dispatch/power_sources/power_source_dispatch.rst

docs/hopp/simulation/technologies/dispatch/power_sources/csp_dispatch.rst

@@ -0,0 +1,10 @@
+.. _CSPDispatch:
+
+
+CSP Dispatch
+============
+
+.. toctree::
+
+.. autoclass:: hopp.simulation.technologies.dispatch.power_sources.csp_dispatch.CspDispatch
+    :members:

docs/hopp/simulation/technologies/dispatch/power_source_dispatch.rst → docs/hopp/simulation/technologies/dispatch/power_sources/power_source_dispatch.rst

@@ -1,15 +1,10 @@
-:orphan:
-
 .. _PowerSourceDispatch:
 
 
-PowerSourceDispatch: Abstract Class
-===================================
-
-Base dispatch class for power source models
+Power Source Dispatch
+=====================
 
 .. toctree::
 
-
 .. autoclass:: hopp.simulation.technologies.dispatch.power_sources.power_source_dispatch.PowerSourceDispatch
-    :members:
+    :members:

docs/hopp/simulation/technologies/dispatch/power_sources/pv_dispatch.rst

@@ -0,0 +1,10 @@
+.. _PVDispatch:
+
+
+PV Dispatch
+===========
+
+.. toctree::
+
+.. autoclass:: hopp.simulation.technologies.dispatch.power_sources.pv_dispatch.PvDispatch
+    :members:

docs/hopp/simulation/technologies/dispatch/power_sources/tower_dispatch.rst

@@ -0,0 +1,10 @@
+.. _TowerDispatch:
+
+
+Tower Dispatch
+==============
+
+.. toctree::
+
+.. autoclass:: hopp.simulation.technologies.dispatch.power_sources.tower_dispatch.TowerDispatch
+    :members:

docs/hopp/simulation/technologies/dispatch/power_sources/trough_dispatch.rst

@@ -0,0 +1,10 @@
+.. _TroughDispatch:
+
+
+Trough Dispatch
+===============
+
+.. toctree::
+
+.. autoclass:: hopp.simulation.technologies.dispatch.power_sources.trough_dispatch.TroughDispatch
+    :members:

docs/hopp/simulation/technologies/dispatch/power_sources/wave_dispatch.rst

@@ -0,0 +1,10 @@
+.. _WaveDispatch:
+
+
+Wave Dispatch
+=============
+
+.. toctree::
+
+.. autoclass:: hopp.simulation.technologies.dispatch.power_sources.wave_dispatch.WaveDispatch
+    :members:

docs/hopp/simulation/technologies/dispatch/power_sources/wind_dispatch.rst

@@ -0,0 +1,10 @@
+.. _WindDispatch:
+
+
+Wind Dispatch
+=============
+
+.. toctree::
+
+.. autoclass:: hopp.simulation.technologies.dispatch.power_sources.wind_dispatch.WindDispatch
+    :members:

docs/hopp/simulation/technologies/dispatch/power_storage/heuristic_load_following_dispatch.rst

@@ -0,0 +1,10 @@
+.. _HeuristicLoadFollowingDispatch:
+
+
+Heuristic Load Following Dispatch
+=================================
+
+.. toctree::
+
+.. autoclass:: hopp.simulation.technologies.dispatch.power_storage.heuristic_load_following_dispatch.HeuristicLoadFollowingDispatch
+    :members:

docs/hopp/simulation/technologies/dispatch/power_storage/linear_voltage_convex_battery_dispatch.rst

@@ -0,0 +1,10 @@
+.. _ConvexLinearVoltageBatteryDispatch:
+
+
+Convex Linear Voltage Battery Dispatch
+======================================
+
+.. toctree::
+
+.. autoclass:: hopp.simulation.technologies.dispatch.power_storage.linear_voltage_convex_battery_dispatch.ConvexLinearVoltageBatteryDispatch
+    :members:

docs/hopp/simulation/technologies/dispatch/power_storage/linear_voltage_nonconvex_battery_dispatch.rst

@@ -0,0 +1,10 @@
+.. _NonConvexLinearVoltageBatteryDispatch:
+
+
+Non-Convex Linear Voltage Battery Dispatch
+==========================================
+
+.. toctree::
+
+.. autoclass:: hopp.simulation.technologies.dispatch.power_storage.linear_voltage_nonconvex_battery_dispatch.NonConvexLinearVoltageBatteryDispatch
+    :members:

docs/hopp/simulation/technologies/dispatch/power_storage/one_cycle_battery_dispatch_heuristic.rst

@@ -0,0 +1,10 @@
+.. _OneCycleBatteryDispatchHeuristic:
+
+
+One Cycle Battery Dispatch Heuristic
+====================================
+
+.. toctree::
+
+.. autoclass:: hopp.simulation.technologies.dispatch.power_storage.one_cycle_battery_dispatch_heuristic.OneCycleBatteryDispatchHeuristic
+    :members:

docs/hopp/simulation/technologies/dispatch/power_storage/power_storage_dispatch.rst

@@ -0,0 +1,10 @@
+.. _PowerStorageDispatch:
+
+
+Power Storage Dispatch
+======================
+
+.. toctree::
+
+.. autoclass:: hopp.simulation.technologies.dispatch.power_storage.power_storage_dispatch.PowerStorageDispatch
+    :members:

docs/hopp/simulation/technologies/dispatch/power_storage/simple_battery_dispatch.rst

@@ -0,0 +1,10 @@
+.. _SimpleBatteryDispatch:
+
+
+Simple Battery Dispatch
+=======================
+
+.. toctree::
+
+.. autoclass:: hopp.simulation.technologies.dispatch.power_storage.simple_battery_dispatch.SimpleBatteryDispatch
+    :members:

docs/hopp/simulation/technologies/dispatch/power_storage/simple_battery_dispatch_heuristic.rst

@@ -0,0 +1,10 @@
+.. _SimpleBatteryDispatchHeuristic:
+
+
+Simple Battery Dispatch Heuristic
+=================================
+
+.. toctree::
+
+.. autoclass:: hopp.simulation.technologies.dispatch.power_storage.simple_battery_dispatch_heuristic.SimpleBatteryDispatchHeuristic
+    :members:

docs/index.rst

@@ -20,7 +20,7 @@ Welcome to HOPP's documentation!
    hopp/simulation/hopp_interface.rst
    hopp/simulation/technologies/sites/site_info.rst
    hopp/simulation/technologies/technologies.rst
-
+   hopp/simulation/technologies/dispatch.rst
 
 .. toctree::
    :maxdepth: 1

hopp/simulation/hybrid_simulation.py

@@ -660,7 +660,14 @@ def simulate_power(self, project_life: int = 25, lifetime_sim=False):
         # Consolidate grid generation by copying over power and storage generation information
         if self.battery:
             self.grid.generation_profile_wo_battery = total_gen_before_battery
-        self.grid.simulate_grid_connection(hybrid_size_kw, total_gen, project_life, lifetime_sim, total_gen_max_feasible_year1)
+        self.grid.simulate_grid_connection(
+            hybrid_size_kw, 
+            total_gen, 
+            project_life, 
+            lifetime_sim,
+            total_gen_max_feasible_year1,
+            self.dispatch_builder.options
+        )
         self.grid.hybrid_nominal_capacity = hybrid_nominal_capacity
         self.grid.total_gen_max_feasible_year1 = total_gen_max_feasible_year1
         logger.info(f"Hybrid Peformance Simulation Complete. AEPs are {self.annual_energies}.")

hopp/simulation/technologies/dispatch/__init__.py

@@ -1,12 +1,26 @@
 from hopp.simulation.technologies.dispatch.power_sources.pv_dispatch import PvDispatch
-from hopp.simulation.technologies.dispatch.power_sources.wind_dispatch import WindDispatch
+from hopp.simulation.technologies.dispatch.power_sources.wind_dispatch import (
+    WindDispatch,
+)
 from hopp.simulation.technologies.dispatch.power_sources.csp_dispatch import CspDispatch
-from hopp.simulation.technologies.dispatch.power_sources.trough_dispatch import TroughDispatch
-from hopp.simulation.technologies.dispatch.power_sources.tower_dispatch import TowerDispatch
-from hopp.simulation.technologies.dispatch.power_sources.wave_dispatch import WaveDispatch
+from hopp.simulation.technologies.dispatch.power_sources.trough_dispatch import (
+    TroughDispatch,
+)
+from hopp.simulation.technologies.dispatch.power_sources.tower_dispatch import (
+    TowerDispatch,
+)
+from hopp.simulation.technologies.dispatch.power_sources.wave_dispatch import (
+    WaveDispatch,
+)
 
 from hopp.simulation.technologies.dispatch.grid_dispatch import GridDispatch
-from hopp.simulation.technologies.dispatch.hybrid_dispatch_options import HybridDispatchOptions
+from hopp.simulation.technologies.dispatch.hybrid_dispatch_options import (
+    HybridDispatchOptions,
+)
 from hopp.simulation.technologies.dispatch.hybrid_dispatch import HybridDispatch
-from hopp.simulation.technologies.dispatch.dispatch_problem_state import DispatchProblemState
-from hopp.simulation.technologies.dispatch.power_storage.simple_battery_dispatch import SimpleBatteryDispatch
+from hopp.simulation.technologies.dispatch.dispatch_problem_state import (
+    DispatchProblemState,
+)
+from hopp.simulation.technologies.dispatch.power_storage.simple_battery_dispatch import (
+    SimpleBatteryDispatch,
+)

hopp/simulation/technologies/dispatch/dispatch.py

@@ -4,18 +4,22 @@
 try:
     u.USD
 except AttributeError:
-    u.load_definitions_from_strings(['USD = [currency]', 'lifecycle = [energy] / [energy]'])
+    u.load_definitions_from_strings(
+        ["USD = [currency]", "lifecycle = [energy] / [energy]"]
+    )
+
 
 class Dispatch:
-    """
+    """ """
 
-    """
-    def __init__(self,
-                 pyomo_model: pyomo.ConcreteModel,
-                 index_set: pyomo.Set,
-                 system_model,
-                 financial_model,
-                 block_set_name: str = 'dispatch'):
+    def __init__(
+        self,
+        pyomo_model: pyomo.ConcreteModel,
+        index_set: pyomo.Set,
+        system_model,
+        financial_model,
+        block_set_name: str = "dispatch",
+    ):
 
         self.block_set_name = block_set_name
         self.round_digits = int(4)
@@ -29,13 +33,19 @@ def __init__(self,
 
     @staticmethod
     def dispatch_block_rule(block, t):
-        raise NotImplemented("This function must be overridden for specific dispatch model")
+        raise NotImplemented(
+            "This function must be overridden for specific dispatch model"
+        )
 
     def initialize_parameters(self):
-        raise NotImplemented("This function must be overridden for specific dispatch model")
+        raise NotImplemented(
+            "This function must be overridden for specific dispatch model"
+        )
 
     def update_time_series_parameters(self, start_time: int):
-        raise NotImplemented("This function must be overridden for specific dispatch model")
+        raise NotImplemented(
+            "This function must be overridden for specific dispatch model"
+        )
 
     @staticmethod
     def _check_efficiency_value(efficiency):