NREL · camirmas · Oct 25, 2023 · Aug 29, 2023 · Aug 31, 2023 · Aug 29, 2023
diff --git a/README.md b/README.md
@@ -26,7 +26,6 @@ solar and storage.
 4. Install requirements:
     ```
     conda install -c conda-forge coin-or-cbc -y
-    conda install -c conda-forge shapely -y
     pip install -r requirements.txt
     ```
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -78,7 +78,7 @@
 PREAMBLE = fh.read()
 fh.close()
 latex_elements = {
-# Additional stuff for the LaTeX preamble.
-'preamble': PREAMBLE,
-'extraclassoptions': 'openany,oneside'
+    # Additional stuff for the LaTeX preamble.
+    'preamble': PREAMBLE,
+    'extraclassoptions': 'openany,oneside'
 }
diff --git a/docs/hopp/simulation/technologies/battery.rst b/docs/hopp/simulation/technologies/battery.rst
@@ -10,5 +10,8 @@ Battery Storage class based on PySAM's BatteryStateful Model
 .. autoclass:: hopp.simulation.technologies.battery.Battery
     :members:
 
+.. autoclass:: hopp.simulation.technologies.battery.BatteryConfig
+    :members:
+
 .. autoclass:: hopp.simulation.technologies.battery.BatteryOutputs
     :members:
diff --git a/docs/hopp/simulation/technologies/battery_stateless.rst b/docs/hopp/simulation/technologies/battery_stateless.rst
@@ -0,0 +1,17 @@
+.. _BatteryStorageStateless:
+
+
+Battery Storage (Stateless)
+================================
+
+Battery Storage class with no system model for tracking the state of the battery.
+
+
+.. autoclass:: hopp.simulation.technologies.battery_stateless.BatteryStateless
+    :members:
+
+.. autoclass:: hopp.simulation.technologies.battery_stateless.BatteryStatelessConfig
+    :members:
+
+.. autoclass:: hopp.simulation.technologies.battery_stateless.BatteryStatelessOutputs
+    :members:
diff --git a/docs/hopp/simulation/technologies/csp_source.rst b/docs/hopp/simulation/technologies/csp_source.rst
@@ -13,6 +13,9 @@ Abstract base class for CSP generation technologies that contains shared methods
 .. autoclass:: hopp.simulation.technologies.csp_source.CspPlant
     :members:
 
+.. autoclass:: hopp.simulation.technologies.csp_source.CspConfig
+    :members:
+
 .. autoclass:: hopp.simulation.technologies.csp_source.CspOutputs
     :members:
     :undoc-members:
diff --git a/docs/hopp/simulation/technologies/detailed_pv_plant.rst b/docs/hopp/simulation/technologies/detailed_pv_plant.rst
@@ -0,0 +1,17 @@
+.. _DetailedPVPlant:
+
+
+Detailed PV Plant
+================================
+
+PV Generator class based on PySAM's PVWatts and Pvsam Models. Allows more
+detailed configuration than `PVPlant`.
+
+.. autoclass:: hopp.simulation.technologies.detailed_pv_plant.DetailedPVPlant
+    :members:
+    :undoc-members:
+
+.. autoclass:: hopp.simulation.technologies.detailed_pv_plant.DetailedPVConfig
+    :members:
+    :undoc-members:
+
diff --git a/docs/hopp/simulation/technologies/grid.rst b/docs/hopp/simulation/technologies/grid.rst
@@ -9,3 +9,8 @@ based on PySAM's Grid module
 
 .. autoclass:: hopp.simulation.technologies.grid.Grid
     :members:
+
+
+.. autoclass:: hopp.simulation.technologies.grid.GridConfig
+    :members:
+    :undoc-members:
diff --git a/docs/hopp/simulation/technologies/mhk_wave_source.rst b/docs/hopp/simulation/technologies/mhk_wave_source.rst
@@ -9,3 +9,15 @@ MHK Wave Generator class
 .. autoclass:: hopp.simulation.technologies.mhk_wave_source.MHKWavePlant
     :members:
     :undoc-members:
+
+.. autoclass:: hopp.simulation.technologies.mhk_wave_source.MHKConfig
+    :members:
+    :undoc-members:
+
+.. autoclass:: hopp.simulation.technologies.financial.mhk_cost_model.MHKCosts
+    :members:
+    :undoc-members:
+
+.. autoclass:: hopp.simulation.technologies.financial.mhk_cost_model.MHKCostModelInputs
+    :members:
+    :undoc-members:
diff --git a/docs/hopp/simulation/technologies/power_source.rst b/docs/hopp/simulation/technologies/power_source.rst
@@ -1,18 +1,10 @@
 .. _PowerSource:
 
-Power Sources and Storage Technologies
-=======================================
+Power Source
+================================
 
-Base class for energy generators:
-
-.. toctree::
-   pv_source.rst
-   wind_source.rst
-   csp_source.rst
-   battery.rst
-   grid.rst
-   mhk_wave_source.rst
+Base class for power generation technologies.
 
 .. autoclass:: hopp.simulation.technologies.power_source.PowerSource
     :members:
-    :exclude-members: copy, plot
+    :exclude-members: copy, plot
diff --git a/docs/hopp/simulation/technologies/pv_source.rst b/docs/hopp/simulation/technologies/pv_source.rst
@@ -1,4 +1,4 @@
-.. _PVSource:
+.. _PVPlant:
 
 
 PV Plant
@@ -9,3 +9,7 @@ PV Generator class based on PySAM's PVWatts and Pvsam Models
 .. autoclass:: hopp.simulation.technologies.pv_source.PVPlant
     :members:
     :undoc-members:
+
+.. autoclass:: hopp.simulation.technologies.pv_source.PVConfig
+    :members:
+    :undoc-members:
diff --git a/docs/hopp/simulation/technologies/technologies.rst b/docs/hopp/simulation/technologies/technologies.rst
@@ -0,0 +1,16 @@
+.. _Technologies:
+
+Power Sources and Storage Technologies
+=======================================
+
+.. toctree::
+   pv_source.rst
+   detailed_pv_plant.rst
+   wind_source.rst
+   csp_source.rst
+   battery.rst
+   battery_stateless.rst
+   grid.rst
+   power_source.rst
+   mhk_wave_source.rst
+
diff --git a/docs/hopp/simulation/technologies/tower_source.rst b/docs/hopp/simulation/technologies/tower_source.rst
@@ -7,5 +7,9 @@ Molten Salt Power Tower Plant
 Tower concentrating solar power class based on SSC's MSPT (molten salt power tower) model
 
 .. autoclass:: hopp.simulation.technologies.tower_source.TowerPlant
+    :members:
+    :undoc-members:
+
+.. autoclass:: hopp.simulation.technologies.tower_source.TowerConfig
     :members:
     :undoc-members:
diff --git a/docs/hopp/simulation/technologies/trough_source.rst b/docs/hopp/simulation/technologies/trough_source.rst
@@ -9,3 +9,7 @@ Parabolic trough concentrating solar power class based on SSC's Parabolic trough
 .. autoclass:: hopp.simulation.technologies.trough_source.TroughPlant
     :members:
     :undoc-members:
+
+.. autoclass:: hopp.simulation.technologies.trough_source.TroughConfig
+    :members:
+    :undoc-members:
diff --git a/docs/hopp/simulation/technologies/wind_source.rst b/docs/hopp/simulation/technologies/wind_source.rst
@@ -8,3 +8,7 @@ Wind Generation class based on PySAM's Windpower module
 
 .. autoclass:: hopp.simulation.technologies.wind_source.WindPlant
     :members:
+
+
+.. autoclass:: hopp.simulation.technologies.wind_source.WindConfig
+    :members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,15 +7,15 @@ Welcome to HOPP's documentation!
 ================================
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
    :caption: Contents:
 
    installation.rst
    citing_hopp.rst
 
    hopp/simulation/technologies/sites/site_info.rst
    hopp/simulation/hybrid_simulation.rst
-   hopp/simulation/technologies/power_source.rst
+   hopp/simulation/technologies/technologies.rst
    hopp/simulation/technologies/dispatch/power_source_dispatch.rst
    hopp/simulation/technologies/layout/flicker.rst
    hopp/using_mybinder.rst 

diff --git a/examples/workshop/01-wind-solar.ipynb b/examples/workshop/01-wind-solar.ipynb
@@ -26,107 +26,33 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "/Users/kbrunik/github/forked/HOPP/examples/workshop/log/hybrid_systems_2023-09-28T09.33.37.529683.log\n"
+      "/Users/cirmas/workspace/HOPP/examples/workshop/log/hybrid_systems_2023-10-23T12.26.42.533329.log\n"
      ]
     }
    ],
    "source": [
-    "from hopp.simulation.hybrid_simulation import HybridSimulation"
+    "from hopp.simulation import HoppInterface"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Set Site Information\n",
-    "Set wind and solar resource data at plant location. In this example, we use the Flatirons site as an example location."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from hopp import ROOT_DIR\n",
-    "from hopp.simulation.technologies.sites import SiteInfo, flatirons_site\n",
-    "\n",
-    "DEFAULT_SOLAR_RESOURCE_FILE = ROOT_DIR.parent / \"resource_files\" / \"solar\" / \"35.2018863_-101.945027_psmv3_60_2012.csv\"\n",
-    "DEFAULT_WIND_RESOURCE_FILE = ROOT_DIR.parent / \"resource_files\" / \"wind\" / \"35.2018863_-101.945027_windtoolkit_2012_60min_80m_100m.srw\"\n",
+    "### Create the HOPP Model\n",
+    "To generate the HOPP Model, instantiate the `HoppInterface` class and supply the required YAML configuration.\n",
     "\n",
+    "Within the YAML configuration, you have the flexibility to define the plant's location details and configure the associated technologies, in this case wind and solar pv.\n",
     "\n",
-    "site = SiteInfo(\n",
-    "        flatirons_site,\n",
-    "        solar_resource_file=DEFAULT_SOLAR_RESOURCE_FILE,\n",
-    "        wind_resource_file=DEFAULT_WIND_RESOURCE_FILE,\n",
-    "        solar=True,\n",
-    "        wind=True,\n",
-    "        wave=False\n",
-    "    )"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Define System Capacities\n",
-    "Specify the capacities of the solar, wind, and interconnection components of the hybrid system in megawatts (MW)."
+    "In this example, we use the Flatirons site as a sample location and configure the wind and solar data for this particular site using pre-existing data files."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "solar_size_mw = 50\n",
-    "wind_size_mw = 50\n",
-    "interconnection_size_mw = 50"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Define Technologies Configuration\n",
-    "Configure the characteristics of each technology in the system, including PV (solar), wind, and grid interconnection."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "technologies = {\n",
-    "    'pv': {\n",
-    "        'system_capacity_kw': solar_size_mw * 1000\n",
-    "    },\n",
-    "    'wind': {\n",
-    "        'num_turbines': 10,\n",
-    "        'turbine_rating_kw': 5000\n",
-    "    },\n",
-    "    'grid': {\n",
-    "        'interconnect_kw': interconnection_size_mw * 1000\n",
-    "    }\n",
-    "}"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Create the Hybrid Simulation Model\n",
-    "Create an instance of the `HybridSimulation` class by providing the technology configuration and site information."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [],
    "source": [
-    "hybrid_plant = HybridSimulation(technologies, site)"
+    "hi = HoppInterface(\"./inputs/01-wind-solar.yaml\")"
    ]
   },
   {
@@ -139,11 +65,11 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [],
    "source": [
-    "hybrid_plant.simulate(25)"
+    "hi.simulate(25)"
    ]
   },
   {
@@ -156,7 +82,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [
     {
@@ -166,16 +92,18 @@
       "Wind Installed Cost: 72700000.0\n",
       "Solar Installed Cost: 48000000.0\n",
       "Hybrid Installed Cost: 120700000.0\n",
-      "Wind NPV: -59123006.66289619\n",
+      "Wind NPV: -58492882.36461778\n",
       "Solar NPV: -35042037.04939877\n",
-      "Hybrid NPV: -95616818.72323646\n",
-      "{\"pv\": 104053614.17593749, \"wind\": 156936144.3525466, \"hybrid\": 250319641.2168857}\n",
-      "{\"pv\": 23.75653291688071, \"wind\": 35.83016994350379, \"hybrid\": 29.793351430192253}\n",
-      "{\"pv\": -35042037.04939877, \"wind\": -59123006.66289619, \"hybrid\": -95616818.72323646}\n"
+      "Hybrid NPV: -95120916.57322481\n",
+      "{\"pv\": 104053614.17593749, \"wind\": 162478037.0463255, \"hybrid\": 254922552.1307209}\n",
+      "{\"pv\": 23.75653291688071, \"wind\": 37.09544224801952, \"hybrid\": 30.425987582450112}\n",
+      "{\"pv\": -35042037.04939877, \"wind\": -58492882.36461778, \"hybrid\": -95120916.57322481}\n"
      ]
     }
    ],
    "source": [
+    "hybrid_plant = hi.system\n",
+    "\n",
     "annual_energies = hybrid_plant.annual_energies\n",
     "npvs = hybrid_plant.net_present_values\n",
     "cf = hybrid_plant.capacity_factors\n",
@@ -203,7 +131,7 @@
    "hash": "c4181dcdfcea4d6481020f2ce48a9cbe5cdfeb7af5e211e5dfd3ac596bfed8bd"
   },
   "kernelspec": {
-   "display_name": "Python 3.8.17 ('storage')",
+   "display_name": "hopp-dev-refactor",
    "language": "python",
    "name": "python3"
   },
@@ -218,9 +146,8 @@
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
    "version": "3.8.17"
-  },
-  "orig_nbformat": 4
+  }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }