outline for rules overview

2019-06-19 13:12:02 +02:00 · 2019-06-19 13:12:02 +02:00 · 7ef5146393
commit 7ef5146393
parent 85631baf99
6 changed files with 89 additions and 15 deletions
--- a/doc/index.rst
+++ b/doc/index.rst
@ -19,18 +19,22 @@ Documentation
   installation
   configuration

-**Rules**
+**Rules Overview**

-
-* :doc:`ruleA`
+* :doc:`preparation`
+* :doc:`simplification`
+* :doc:`solving`
+* :doc:`plotting`

 .. toctree::
   :hidden:
   :maxdepth: 1
-   :caption: Rules
-
-   ruleA
+   :caption: Rules Overview

+   preparation
+   simplification
+   solving
+   plotting
   
 **References**
   
--- a/doc/plotting.rst
+++ b/doc/plotting.rst
@ -0,0 +1,12 @@
+##########################################
+Plotting and Summary
+##########################################
+
+Make Summary
+============
+
+Plot Summary
+============
+
+Plot Network
+============
--- a/doc/preparation.rst
+++ b/doc/preparation.rst
@ -0,0 +1,43 @@
+##########################################
+Preparing Networks
+##########################################
+
+.. each rule description should have a list of parameters
+.. from the config.yaml that affect this rule.
+
+Build Shapes
+=============================
+
+Build Natura Raster
+=============================
+
+Build Cutout
+=============================
+
+Prepare HVDC Links
+=============================
+
+Base Networks
+=============================
+
+Build Bus Regions
+=============================
+
+Build Country Full Load Hours
+=============================
+
+Build Hydro Profile
+=============================
+
+Build Renewabe Profiles
+=============================
+
+Build Renewable Potentials
+=============================
+
+Build Power Plants
+=============================
+
+Add Electricity
+=============================
+
--- a/doc/ruleA.rst
+++ b/doc/ruleA.rst
@ -1,9 +0,0 @@
-##########################################
-Rule A
-##########################################
-
-Section A
-=========
-
-Section B
-=========
--- a/doc/simplification.rst
+++ b/doc/simplification.rst
@ -0,0 +1,12 @@
+##########################################
+Simplifying Networks
+##########################################
+
+Simplify Network
+================
+
+Cluster Network
+===============
+
+Prepare Network
+===============
--- a/doc/solving.rst
+++ b/doc/solving.rst
@ -0,0 +1,12 @@
+##########################################
+Solving Networks
+##########################################
+
+Solve Network
+=============
+
+Trace Solve Network
+===================
+
+Solve Operations Network
+========================