Merge pull request #752 from openego/features/update-module-structure-v2

Features/update module structure v2
openego · Aug 14, 2024 · 3e50624 · 3e50624
2 parents ba3982d + 1f2a52a
commit 3e50624
Show file tree

Hide file tree

Showing 22 changed files with 440 additions and 296 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -6,6 +6,10 @@ API
    :glob:
    :titlesonly:
 
+   api/etrago.analyze
    api/etrago.cluster
+   api/etrago.disaggregate
+   api/etrago.execute
    api/etrago.tools
    api/appl.rst
+   api/network.rst
diff --git a/doc/api/etrago.analyze.rst b/doc/api/etrago.analyze.rst
@@ -0,0 +1,20 @@
+etrago.analyze package
+======================
+
+etrago.analyze.calc\_results module
+-----------------------------------
+
+.. automodule:: etrago.analyze.calc_results
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+etrago.analyze.plot module
+---------------------------
+
+.. automodule:: etrago.analyze.plot
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
diff --git a/doc/api/etrago.cluster.rst b/doc/api/etrago.cluster.rst
@@ -1,13 +1,6 @@
 etrago.cluster package
 =======================
 
-etrago.cluster.disaggregation module
------------------------------------------
-
-.. automodule:: etrago.cluster.disaggregation
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
 etrago.cluster.electrical module
 -----------------------------------------
@@ -25,10 +18,10 @@ etrago.cluster.gas module
     :undoc-members:
     :show-inheritance:
 
-etrago.cluster.snapshot module
+etrago.cluster.temporal module
 --------------------------------
 
-.. automodule:: etrago.cluster.snapshot
+.. automodule:: etrago.cluster.temporal
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/doc/api/etrago.disaggregate.rst b/doc/api/etrago.disaggregate.rst
@@ -0,0 +1,19 @@
+etrago.disaggregate package
+===========================
+
+etrago.disaggregate.spatial module
+----------------------------------
+
+.. automodule:: etrago.disaggregate.spatial
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+etrago.disaggregate.temporal module
+-----------------------------------
+
+.. automodule:: etrago.disaggregate.temporal
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/doc/api/network.rst b/doc/api/network.rst
@@ -0,0 +1,7 @@
+etrago.network module
+-------------------
+
+.. automodule:: etrago.network
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/etrago/__init__.py b/etrago/__init__.py
@@ -12,4 +12,4 @@
 __author__ = "ulfmueller, lukasol, wolfbunke, mariusves, s3pp"
 __version__ = "0.4"
 
-from etrago.tools.network import Etrago
+from etrago.network import Etrago
diff --git a/etrago/analyze/__init__.py b/etrago/analyze/__init__.py
@@ -0,0 +1,7 @@
+"""
+
+"""
+
+__copyright__ = "tba"
+__license__ = "tba"
+__author__ = "tba"
diff --git a/etrago/tools/calc_results.py → etrago/analyze/calc_results.py b/etrago/tools/calc_results.py → etrago/analyze/calc_results.py