Dev

README.md

@@ -1,7 +1,14 @@
 # IDAES-GTEP
-IDAES Generation and Transmission Expansion Planning
 
+<!-- BEGIN Status Badges -->
 [![GitHub CI](https://github.com/IDAES/idaes-gtep/actions/workflows/test_pr_and_main.yml/badge.svg?branch=main&event=push)](https://github.com/IDAES/idaes-gtep/actions/workflows/test_pr_and_main.yml)
 [![Documentation Status](https://readthedocs.org/projects/idaes-gtep/badge/?version=latest)](http://idaes-gtep.readthedocs.org/en/latest/)
+<!-- END Status Badges -->
 
-[Documentation](https://idaes-gtep.readthedocs.io)
+The IDAES Generation and Transmission Expansion Planning (GTEP) package provides a [Pyomo](https://github.com/Pyomo/pyomo)-based implementation of a modular, flexible, Generalized Disjunctive Programming (GDP) formulation for power infrastructure planning problems.  This formulation is designed with the following goals in mind:
+
+- Abstract GTEP modeling away from any particular case study or fixed modeling assumptions (e.g., technologies, temporal resolution, spatial resolution, policy implications, etc.)
+- Admit flexible decision sets and heterogeneous parameterization
+- Allow high-level modeling options to be understood easily, chosen modularly, and changed rapidly
+
+You can find the latest documentation [here](https://idaes-gtep.readthedocs.io).

docs/source/conf.py

@@ -7,6 +7,9 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../.."))
 
 project = "idaes-gtep"
 copyright = "2024, Kyle Skolfield"

docs/source/data.rst

@@ -1,2 +1,10 @@
 Data
-====
+====
+.. currentmodule:: gtep.gtep_data
+
+.. automodule:: gtep
+    :members:
+
+.. automodule:: gtep.gtep_data
+    :members: 
+

docs/source/modeling.rst

@@ -1,5 +1,6 @@
 Modeling 
 =============================
+.. currentmodule:: gtep.gtep_model
 
 .. automodule:: gtep
     :members:

gtep/driver.py

@@ -10,7 +10,7 @@
 data_object = ExpansionPlanningData()
 data_object.load_prescient(data_path)
 mod_object = ExpansionPlanningModel(
-    data=data_object, num_reps=1, len_reps=1, num_commit=1, num_dispatch=1
+    data=data_object.md, num_reps=1, len_reps=1, num_commit=1, num_dispatch=1
 )
 mod_object.create_model()
 TransformationFactory("gdp.bound_pretransformation").apply_to(mod_object.model)

gtep/gtep_data.py

@@ -11,10 +11,17 @@
 
 
 class ExpansionPlanningData:
+    """Standard data storage class for the IDAES GTEP model."""
+
     def __init__(self):
         pass
 
     def load_prescient(self, data_path, options_dict=None):
+        """Loads data structured via Prescient data loader.
+
+        :param data_path: Folder containing the data to be loaded
+        :param options_dict: Options dictionary to pass to the Prescient data loader, defaults to None
+        """
         self.data_type = "prescient"
         options_dict = {
             "data_path": data_path,
@@ -25,6 +32,7 @@ def load_prescient(self, data_path, options_dict=None):
             "sced_frequency_minutes": 60,
             "ruc_horizon": 36,
         }
+
         prescient_options = PrescientConfig()
         prescient_options.set_value(options_dict)
         # Use prescient data provider to load in sequential data for representative periods
@@ -73,6 +81,8 @@ def load_prescient(self, data_path, options_dict=None):
         self.representative_data = data_list
 
     def load_default_data_settings(self):
+        ## TODO: too many of these are hard coded; everything should check if it exists too.
+        """Fills in necessary but unspecified data information."""
         for gen in self.md.data["elements"]["generator"]:
             self.md.data["elements"]["generator"][gen]["lifetime"] = 3
             self.md.data["elements"]["generator"][gen]["spinning_reserve_frac"] = 0.1