Merging

jylambert · Sep 24, 2024 · 3d4669d · 3d4669d
2 parents 60189df + aced3b0
commit 3d4669d
Show file tree

Hide file tree

Showing 41 changed files with 24 additions and 13 deletions.
diff --git a/example/calculate_hydraulic_reg.py → ...s/one-producer/calculate_hydraulic_reg.py b/example/calculate_hydraulic_reg.py → ...s/one-producer/calculate_hydraulic_reg.py
diff --git a/example/data/A_c.parquet → examples/one-producer/data/A_c.parquet b/example/data/A_c.parquet → examples/one-producer/data/A_c.parquet
diff --git a/example/data/A_i.parquet → examples/one-producer/data/A_i.parquet b/example/data/A_i.parquet → examples/one-producer/data/A_i.parquet
diff --git a/example/data/A_p.parquet → examples/one-producer/data/A_p.parquet b/example/data/A_p.parquet → examples/one-producer/data/A_p.parquet
diff --git a/example/data/L_i.parquet → examples/one-producer/data/L_i.parquet b/example/data/L_i.parquet → examples/one-producer/data/L_i.parquet
diff --git a/example/data/Q_c.parquet → examples/one-producer/data/Q_c.parquet b/example/data/Q_c.parquet → examples/one-producer/data/Q_c.parquet
diff --git a/bm/data/config.yaml → examples/one-producer/data/config.yaml b/bm/data/config.yaml → examples/one-producer/data/config.yaml
diff --git a/bm/data/regression.csv → examples/one-producer/data/regression.csv b/bm/data/regression.csv → examples/one-producer/data/regression.csv
diff --git a/example/data/rel_positions.parquet → ...s/one-producer/data/rel_positions.parquet b/example/data/rel_positions.parquet → ...s/one-producer/data/rel_positions.parquet
diff --git a/example/data/timeseries.csv → examples/one-producer/data/timeseries.csv b/example/data/timeseries.csv → examples/one-producer/data/timeseries.csv
diff --git a/example/run_mts.py → examples/one-producer/run_mts.py b/example/run_mts.py → examples/one-producer/run_mts.py
diff --git a/example/run_mts_easy.py → examples/one-producer/run_mts_easy.py b/example/run_mts_easy.py → examples/one-producer/run_mts_easy.py
diff --git a/example/run_sts.py → examples/one-producer/run_sts.py b/example/run_sts.py → examples/one-producer/run_sts.py
diff --git a/bm/convert_npy_to_parquet.py → ...nthetic-network/convert_npy_to_parquet.py b/bm/convert_npy_to_parquet.py → ...nthetic-network/convert_npy_to_parquet.py
diff --git a/bm/data/A_c.npy → examples/synthetic-network/data/A_c.npy b/bm/data/A_c.npy → examples/synthetic-network/data/A_c.npy
diff --git a/bm/data/A_c.parquet → examples/synthetic-network/data/A_c.parquet b/bm/data/A_c.parquet → examples/synthetic-network/data/A_c.parquet
diff --git a/bm/data/A_i.npy → examples/synthetic-network/data/A_i.npy b/bm/data/A_i.npy → examples/synthetic-network/data/A_i.npy
diff --git a/bm/data/A_i.parquet → examples/synthetic-network/data/A_i.parquet b/bm/data/A_i.parquet → examples/synthetic-network/data/A_i.parquet
diff --git a/bm/data/A_p.npy → examples/synthetic-network/data/A_p.npy b/bm/data/A_p.npy → examples/synthetic-network/data/A_p.npy
diff --git a/bm/data/A_p.parquet → examples/synthetic-network/data/A_p.parquet b/bm/data/A_p.parquet → examples/synthetic-network/data/A_p.parquet
diff --git a/bm/data/L_i.parquet → examples/synthetic-network/data/L_i.parquet b/bm/data/L_i.parquet → examples/synthetic-network/data/L_i.parquet
diff --git a/bm/data/Q_c.npy → examples/synthetic-network/data/Q_c.npy b/bm/data/Q_c.npy → examples/synthetic-network/data/Q_c.npy
diff --git a/bm/data/Q_c.parquet → examples/synthetic-network/data/Q_c.parquet b/bm/data/Q_c.parquet → examples/synthetic-network/data/Q_c.parquet
diff --git a/example/data/config.yaml → examples/synthetic-network/data/config.yaml b/example/data/config.yaml → examples/synthetic-network/data/config.yaml
diff --git a/bm/data/l_i.npy → examples/synthetic-network/data/l_i.npy b/bm/data/l_i.npy → examples/synthetic-network/data/l_i.npy
diff --git a/example/data/regression.csv → ...les/synthetic-network/data/regression.csv b/example/data/regression.csv → ...les/synthetic-network/data/regression.csv
diff --git a/bm/data/rel_positions.npy → .../synthetic-network/data/rel_positions.npy b/bm/data/rel_positions.npy → .../synthetic-network/data/rel_positions.npy
diff --git a/bm/data/rel_positions.parquet → ...thetic-network/data/rel_positions.parquet b/bm/data/rel_positions.parquet → ...thetic-network/data/rel_positions.parquet
diff --git a/bm/run_sts.py → examples/synthetic-network/run_sts.py b/bm/run_sts.py → examples/synthetic-network/run_sts.py
diff --git a/example_2_prod/data/A_c.parquet → examples/two-producers/data/A_c.parquet b/example_2_prod/data/A_c.parquet → examples/two-producers/data/A_c.parquet
diff --git a/example_2_prod/data/A_i.parquet → examples/two-producers/data/A_i.parquet b/example_2_prod/data/A_i.parquet → examples/two-producers/data/A_i.parquet
diff --git a/example_2_prod/data/A_p.parquet → examples/two-producers/data/A_p.parquet b/example_2_prod/data/A_p.parquet → examples/two-producers/data/A_p.parquet
diff --git a/example_2_prod/data/L_i.parquet → examples/two-producers/data/L_i.parquet b/example_2_prod/data/L_i.parquet → examples/two-producers/data/L_i.parquet
diff --git a/example_2_prod/data/Q_c.parquet → examples/two-producers/data/Q_c.parquet b/example_2_prod/data/Q_c.parquet → examples/two-producers/data/Q_c.parquet
diff --git a/example_2_prod/data/config.yaml → examples/two-producers/data/config.yaml b/example_2_prod/data/config.yaml → examples/two-producers/data/config.yaml
diff --git a/example_2_prod/data/regression.csv → examples/two-producers/data/regression.csv b/example_2_prod/data/regression.csv → examples/two-producers/data/regression.csv
diff --git a/example_2_prod/data/rel_positions.parquet → .../two-producers/data/rel_positions.parquet b/example_2_prod/data/rel_positions.parquet → .../two-producers/data/rel_positions.parquet
diff --git a/example_2_prod/run_sts_two_producers.py → ...es/two-producers/run_sts_two_producers.py b/example_2_prod/run_sts_two_producers.py → ...es/two-producers/run_sts_two_producers.py
diff --git a/setup.py b/setup.py
@@ -1,21 +1,24 @@
-"""Set up the package from requirments."""
-import os
+"""Set up topotherm from requirements."""
 
+import os
 from setuptools import setup, find_packages
 
+
 # The directory containing this file
 here = os.path.dirname(os.path.realpath(__file__))
+
 # The text of the README file
-with open(os.path.join(here, "README.md")) as fid:
+with open(os.path.join(here, "README.md"), encoding='utf-8') as fid:
     readme = fid.read()
-with open(os.path.join(here, "requirements.txt")) as fid:
+
+with open(os.path.join(here, "requirements.txt"), encoding='utf-8') as fid:
     reqs = fid.read().splitlines()
 
 # This call to setup() does all the work
 setup(
     name="topotherm",
     version="0.1.0",
-    description="A package to optimize district heating systems",
+    description="A package to design district heating networks",
     long_description=readme,
     long_description_content_type="text/markdown",
     url="https://github.com/jylambert/topotherm",

diff --git a/tests/hydraulics.py b/tests/hydraulics.py
@@ -9,6 +9,7 @@
 
 
 def test_feed_line_temp():
+    """Test feed line temperature calculation"""
     # Optionally: calculate the supply temperatures for a given max supply t and
     # return temperature according to ambient temperature
     variable_feed_temp = precalc.determine_feed_line_temp(
@@ -22,14 +23,14 @@ def test_feed_line_temp():
 
 
 def test_regression():
-    """Test regression"""
+    """Test thermal capacity and thermal losses regression"""
     r_thermal_cap = precalc.regression_thermal_capacity(settings)
     assert abs(r_thermal_cap['a'] - 0.018377) < 0.01 * 0.018377
     assert abs(r_thermal_cap['b'] - 567.335) < 0.01 * 567.335
     assert abs(r_thermal_cap['r2'] - 0.869778) < 0.01 * 0.869778
     # heat loss regression
-    r_heat_loss = precalc.regression_heat_losses(settings,
-                                                 thermal_capacity=r_thermal_cap)
+    r_heat_loss = precalc.regression_heat_losses(
+        settings, thermal_capacity=r_thermal_cap)
     # assert that each params item is within 1% of the expected value
     assert abs(r_heat_loss['a'] - 4.348000e-07) < 0.01 * 4.348000e-07
     assert abs(r_heat_loss['b'] - 0.02189) < 0.01 * 0.02189

diff --git a/topotherm/postprocessing.py b/topotherm/postprocessing.py
@@ -1,8 +1,14 @@
-"""Postprocessing of the results from the optimization. This includes the calculation of the
-diameter and mass flow of the pipes, the elimination of unused pipes and nodes.
+"""Postprocessing of the results from the optimization. This includes the 
+calculation of the diameter and mass flow of the pipes, the elimination of
+unused pipes and nodes.
 
 This module includes the following functions:
-    * sts: Postprocessing for the STS model
+    * calc_diam_and_velocity: Equations for the calculation of the diameter and
+    velocity of the pipes depending on the mass flow and the power of the pipes
+    * sts: Postprocessing for the single time step model
+    * to_networkx_graph: Export the postprocessed, optimal district as a
+    networkx graph
+    * mts: Postprocessing for the multiple time step model
 """
 
 from typing import Tuple
@@ -58,7 +64,7 @@ def sts(model: pyo.ConcreteModel,
         settings (tt.settings.Settings): settings for the optimization
     
     Returns:
-        _dict: containing the variables and postprocessed data
+        res: containing the variables and postprocessed data
     """
     # Get the values from the model
     p_ij = np.array(pyo.value(model.P['ij', 'in', :, :]))
@@ -296,7 +302,8 @@ def to_networkx_graph(matrices):
         - m_i_0 (mass flow of the optimal pipes)
         - p (Power of the optimal pipes)
         
-    Returns: Figure of the district
+    Returns:
+        G: networkx graph
     """
     G = nx.DiGraph()
     s = np.array([0, 0, 0])