Merge pull request #136 from Project-OMOTES/validation_pipe_diameter_…

…sizing DOC: Validation pipe diameter sizing in rst file format
Project-OMOTES · Mar 14, 2024 · 033c535 · 033c535
2 parents 8af21df + bdc72e7
commit 033c535
Show file tree

Hide file tree

Showing 24 changed files with 1,484 additions and 259 deletions.
diff --git a/docs/bibliography.rst b/docs/bibliography.rst
@@ -0,0 +1,7 @@
+Bibliography
+============
+
+.. bibliography::
+   :filter: cited
+   :style: plain
+
diff --git a/docs/conf.py b/docs/conf.py
@@ -21,9 +21,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'RTC-Tools Heat Network'
-copyright = '2020, Teresa Piovesan et al.'
-author = 'Teresa Piovesan, et al.'
+project = 'Nieuwe Warmte Nu - Design Toolkit'
+author = 'Kelbij Star, Teresa Piovesan, et al.'
+review = 'Jesus Andres Rodriguez Sarasty, Ivo Pothof, Mike van Meerkerk'
 
 
 # -- General configuration ---------------------------------------------------
@@ -36,7 +36,24 @@
               'sphinx.ext.todo',
               'sphinx.ext.coverage',
               'sphinx.ext.mathjax',
-              'sphinx.ext.viewcode']
+              'sphinx.ext.viewcode',
+              'sphinx.ext.graphviz',
+              'sphinx.ext.autosectionlabel',
+              'sphinxcontrib.bibtex']
+
+mathjax3_config = {'chtml': {'displayAlign': 'left',
+                             'displayIndent': '2em'}}
+
+bibtex_bibfiles = ['references.bib']
+
+# -- GraphViz configuration ----------------------------------
+graphviz_output_format = 'svg'
+
+# Make sure the target is unique
+autosectionlabel_prefix_document = True
+
+# Enable numref
+numfig = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -75,4 +92,4 @@
 ]
 
 # Intersphinx: refer to the RTC-Tools standard library.
-intersphinx_mapping = {'rtctools': ('https://rtc-tools.readthedocs.io/en/latest/', None)}
+# intersphinx_mapping = {'rtctools': ('https://rtc-tools.readthedocs.io/en/latest/', None)}
diff --git a/docs/examples/index.rst b/docs/examples/index.rst
diff --git a/docs/getting-started.rst b/docs/getting-started.rst
diff --git a/docs/images/ESDL_model_pipe_basic_attributes.png b/docs/images/ESDL_model_pipe_basic_attributes.png
diff --git a/docs/images/HeatingDemandProfile.png b/docs/images/HeatingDemandProfile.png
diff --git a/docs/images/KPI_dashboard.png b/docs/images/KPI_dashboard.png
diff --git a/docs/images/V_pipe_d_sizing_ESDL_model.png b/docs/images/V_pipe_d_sizing_ESDL_model.png
diff --git a/docs/images/V_pipe_d_sizing_WANDA_model.png b/docs/images/V_pipe_d_sizing_WANDA_model.png
diff --git a/docs/images/physics_validation.png b/docs/images/physics_validation.png
diff --git a/docs/images/physics_validation_costs.png b/docs/images/physics_validation_costs.png
diff --git a/docs/images/physics_validation_temperature.png b/docs/images/physics_validation_temperature.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,45 +1,18 @@
-.. RTC-Tools Heat Network documentation master file, created by
-   sphinx-quickstart on Wed Jul 15 13:28:40 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
-RTC-Tools Heat Network's documentation
-======================================
+Design Toolkit's optimizer documentation
+========================================
 
-This is the documentation for RTC-Tools Heat Network, a library for model-predictive control of heat networks.
-The library development was funded as part of `WarmingUP <https://www.warmingup.info>`_ project.
+This is the documentation for optimizer routine, to optimize the conceptional design of heating networks.
 
-The documentation covers:
-
-    - How to get it running on your computer.
-    - The optimization approach, its rationale, and the underlying equations and assumptions.
-    - Example use of the RTC-Tools Heat Network library.
-    - An overview of the Python API, to construct your own optimization models.
 
 .. toctree::
    :maxdepth: 2
-   :caption: User Documentation
-
-   getting-started
-   support
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Theory
+   :caption: Optimizer routine
 
    theory/index
+   support
+   bibliography
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Examples
-
-   examples/index
-
-.. toctree::
-   :maxdepth: 2
-   :caption: API Documentation
-
-   python-api
 
 Indices and tables
 ==================

diff --git a/docs/pdfs/Doc_pipe_diameter_sizing.pdf b/docs/pdfs/Doc_pipe_diameter_sizing.pdf
diff --git a/docs/python-api.rst b/docs/python-api.rst
diff --git a/docs/references.bib b/docs/references.bib
@@ -0,0 +1,85 @@
+@Book{Pothof2011,
+  author    = {Pothof, I.W.M.},
+  publisher = {Gildeprint Drukkerijen BV, Enschede},
+  title     = {Co-current air-water flow in downward sloping pipes},
+  year      = {2011},
+  isbn      = {978-90-89577-018-5},
+}
+
+@Article{Boehm2000,
+  author    = {Boehm, B.},
+  title     = {On transient heat losses from buried district heating pipes},
+  year      = {2000},
+  journal   = {International journal of energy},
+  volume    = {24},
+  pages     = {1311-1334},
+  isbn      = {978-90-89577-018-5},
+}
+
+@Book{Mills1999,
+  author    = {Mills, A.F.},
+  publisher = {Prentice Hall, Inc.},
+  title     = {Basic heat and mass transfer},
+  year      = {1999},
+  edition   = {2},
+}
+
+@Book{Incropera1985,
+  author    = {Incropera, F.P. and D.P. De Witt},
+  publisher = {John Wiley & Sons inc.},
+  title     = {Fundamentals of heat and mass transfer},
+  year      = {1985},
+  edition   = {2},
+}
+
+@Misc{Dullemond,
+  author    = {Dullemond C.P. and Wang A.A.},
+  publisher = {Heidelberg University},
+  howpublished = {http://www.mpia.de/homes/dullemon/lectures/fluiddynamics/},
+}
+
+
+@Book{ISSOPublicatie72012,
+  author    = {ISSO Publicatie 7},
+  publisher = {Stichting ISSO},
+  title     = {Grondleidingen voor warmte en koude transport},
+  year      = {2012},
+  isbn      = {ISBN:978-90-5044-232-9},
+}
+
+@Book{NEN-EN13941+A1,
+  author    = {NEN-EN 13941+A1},
+  publisher = {NEN},
+  title     = {Ontwerp en installatie voor geïsoleerde buissystemen voor stadsverwarming},
+  year      = {2010},
+}
+
+@Book{Kuppan2013,
+  author    = {T. Kuppan},
+  publisher = {CRC Press},
+  title     = {Heat exchanger design handbook},
+  year      = {2013},
+} 
+
+@Article{Tukker2016,
+  author    = {M. Tukker and K. Kooij and I. Pothof},
+  journal   = {Water Intelligence Online},
+  title     = {Hydraulic Design and Management of Wastewater Transport Systems},
+  year      = {2016},
+  month     = {apr},
+  number    = {0},
+  pages     = {9781780407814--9781780407814},
+  volume    = {15},
+  doi       = {10.2166/9781780407814},
+  publisher = {{IWA} Publishing},
+}
+
+@Book{Wylie1978,
+  author    = {Wylie, E.B. and Streeter, V.L.},
+  publisher = {McGraw-Hill International Book Co.},
+  title     = {Fluid transients},
+  year      = {1978},
+}
+
+@Comment{jabref-meta: databaseType:bibtex;}
+
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
-numpy
-sphinx
-sphinx_rtd_theme
+numpy >= 1.22
+sphinx ==  7.1.2
+sphinx_rtd_theme == 2.0.0
+sphinxcontrib.bibtex >= 2.6
diff --git a/docs/support.rst b/docs/support.rst
@@ -2,4 +2,4 @@
 Support
 #######
 
-Raise any issue on `GitLab <https://ci.tno.nl/gitlab/warmingup/rtc-tools-heat-network/issues>`_ such that we can address your problem.
+Raise any issue on `Github <https://github.com/Project-OMOTES/rtc-tools-heat-network/issues>`_ such that we can address your problem.
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,4 +2,4 @@ @@
     Support
     #######
-    Raise any issue on `GitLab <https://ci.tno.nl/gitlab/warmingup/rtc-tools-heat-network/issues>`_ such that we can address your problem.
+    Raise any issue on `Github <https://github.com/Project-OMOTES/rtc-tools-heat-network/issues>`_ such that we can address your problem.