diff --git a/doc/index.rst b/doc/index.rst index 53f4438d..7af93e37 100644 --- 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 + :caption: Rules Overview - ruleA - + preparation + simplification + solving + plotting **References** diff --git a/doc/plotting.rst b/doc/plotting.rst new file mode 100644 index 00000000..f61a8dcd --- /dev/null +++ b/doc/plotting.rst @@ -0,0 +1,12 @@ +########################################## +Plotting and Summary +########################################## + +Make Summary +============ + +Plot Summary +============ + +Plot Network +============ diff --git a/doc/preparation.rst b/doc/preparation.rst new file mode 100644 index 00000000..fe0bcdd0 --- /dev/null +++ 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 +============================= + diff --git a/doc/ruleA.rst b/doc/ruleA.rst deleted file mode 100644 index 5890d8e7..00000000 --- a/doc/ruleA.rst +++ /dev/null @@ -1,9 +0,0 @@ -########################################## -Rule A -########################################## - -Section A -========= - -Section B -========= diff --git a/doc/simplification.rst b/doc/simplification.rst new file mode 100644 index 00000000..9f786ee0 --- /dev/null +++ b/doc/simplification.rst @@ -0,0 +1,12 @@ +########################################## +Simplifying Networks +########################################## + +Simplify Network +================ + +Cluster Network +=============== + +Prepare Network +=============== diff --git a/doc/solving.rst b/doc/solving.rst new file mode 100644 index 00000000..1cf9dcba --- /dev/null +++ b/doc/solving.rst @@ -0,0 +1,12 @@ +########################################## +Solving Networks +########################################## + +Solve Network +============= + +Trace Solve Network +=================== + +Solve Operations Network +========================