Merge branch 'main' of https://github.com/PREP-NexT/PREP-SHOT

PREP-NexT · Jul 11, 2024 · e8aa88f · e8aa88f
2 parents 6cfe06d + 990357c
commit e8aa88f
Show file tree

Hide file tree

Showing 16 changed files with 122 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -74,7 +74,7 @@ This section includes a brief tutorial on running your first PREP-SHOT model.
 
 This example is inspired by real-world data. For a detailed elaboration of this tutorial, check out the [Tutorial Page](https://prep-next.github.io/PREP-SHOT/Tutorial.html) in our documentation.
 
-By default, PREP-SHOT uses open-source freely [HiGHS](https://github.com/jump-dev/HiGHS.jl) solver. Solver-specific settings parameters are specified in the ``config.json`` file, which should be located in the current working directory. We also provide the option to use one of these three commercial solvers:
+By default, PREP-SHOT uses open-source [HiGHS](https://github.com/jump-dev/HiGHS.jl) solver. Solver-specific parameters are specified in the ``config.json`` file, which should be located in the current working directory. Additionaly, we provide the option to use one of the following three commercial solvers:
 
 + [Gurobi](https://www.gurobi.com/)
 + [COPT](https://www.copt.de/)

diff --git a/doc/source/api/prepshot._model.co2.rst b/doc/source/api/prepshot._model.co2.rst
@@ -0,0 +1,8 @@
+PREP-SHOT.constraints.co2
+==========================
+
+.. automodule:: prepshot._model.co2
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/api/prepshot._model.cost.rst b/doc/source/api/prepshot._model.cost.rst
@@ -0,0 +1,8 @@
+PREP-SHOT.constraints.cost
+==========================
+
+.. automodule:: prepshot._model.cost
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/api/prepshot._model.demand.rst b/doc/source/api/prepshot._model.demand.rst
@@ -0,0 +1,8 @@
+PREP-SHOT.constraints.demand
+===============================
+
+.. automodule:: prepshot._model.demand
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/api/prepshot._model.generation.rst b/doc/source/api/prepshot._model.generation.rst
@@ -0,0 +1,8 @@
+PREP-SHOT.constraints.generation
+=================================
+
+.. automodule:: prepshot._model.generation
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/api/prepshot._model.head_iteration.rst b/doc/source/api/prepshot._model.head_iteration.rst
@@ -0,0 +1,8 @@
+PREP-SHOT.constraints.head_iteration
+=====================================
+
+.. automodule:: prepshot._model.head_iteration
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/api/prepshot._model.hydro.rst b/doc/source/api/prepshot._model.hydro.rst
@@ -0,0 +1,8 @@
+PREP-SHOT.constraints.hydro
+==============================
+
+.. automodule:: prepshot._model.hydro
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/api/prepshot._model.investment.rst b/doc/source/api/prepshot._model.investment.rst
@@ -0,0 +1,8 @@
+PREP-SHOT.constraints.investment
+=================================
+
+.. automodule:: prepshot._model.investment
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/api/prepshot._model.nondispatchable.rst b/doc/source/api/prepshot._model.nondispatchable.rst
@@ -0,0 +1,8 @@
+PREP-SHOT.constraints.nondispatchable
+=======================================
+
+.. automodule:: prepshot._model.nondispatchable 
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/api/prepshot._model.rst b/doc/source/api/prepshot._model.rst
@@ -0,0 +1,22 @@
+PREP-SHOT.constraints
+==========================
+
+.. automodule:: prepshot._model
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
+
+.. toctree::
+    :maxdepth: 2
+
+    prepshot._model.co2.rst
+    prepshot._model.cost.rst
+    prepshot._model.demand.rst
+    prepshot._model.generation.rst
+    prepshot._model.head_iteration.rst
+    prepshot._model.hydro.rst
+    prepshot._model.investment.rst
+    prepshot._model.nondispatchable.rst
+    prepshot._model.storage.rst
+    prepshot._model.transmission.rst
diff --git a/doc/source/api/prepshot._model.storage.rst b/doc/source/api/prepshot._model.storage.rst
@@ -0,0 +1,8 @@
+PREP-SHOT.constraints.storage
+===============================
+
+.. automodule:: prepshot._model.storage
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/api/prepshot._model.transmission.rst b/doc/source/api/prepshot._model.transmission.rst
@@ -0,0 +1,8 @@
+PREP-SHOT.constraints.transmission
+===================================
+
+.. automodule:: prepshot._model.transmission
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/api/prepshot.parameters.rst → doc/source/api/prepshot.output_data.rst b/doc/source/api/prepshot.parameters.rst → doc/source/api/prepshot.output_data.rst
@@ -1,7 +1,7 @@
-PREP-SHOT.parameters
+PREP-SHOT.output_data
 ====================================
 
-.. automodule:: prepshot.parameters
+.. automodule:: prepshot.output_data
     :members:
     :inherited-members:
     :undoc-members:

diff --git a/doc/source/api/prepshot.rst b/doc/source/api/prepshot.rst
@@ -8,10 +8,13 @@ API Reference
 
 .. toctree::
     :maxdepth: 2
-
-    prepshot.load_data.rst
+    
+    prepshot.set_up.rst
     prepshot.logs.rst
+    prepshot.load_data.rst
+    prepshot.solver.rst
     prepshot.model.rst
-    prepshot.parameters.rst
-    prepshot.rules.rst
+    prepshot._model.rst
     prepshot.utils.rst
+    prepshot.output_data.rst
+
diff --git a/doc/source/api/prepshot.rules.rst → doc/source/api/prepshot.set_up.rst b/doc/source/api/prepshot.rules.rst → doc/source/api/prepshot.set_up.rst
@@ -1,7 +1,7 @@
-PREP-SHOT.rules
+PREP-SHOT.set_up
 ====================================
 
-.. automodule:: prepshot.rules
+.. automodule:: prepshot.set_up
     :members:
     :inherited-members:
     :undoc-members:

diff --git a/doc/source/api/prepshot.solver.rst b/doc/source/api/prepshot.solver.rst
@@ -0,0 +1,8 @@
+PREP-SHOT.solver
+==========================
+
+.. automodule:: prepshot.solver
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance: