Merge pull request #44 from USEPA/ShangDev

PDA equations, Tables in Chapter 8, etc.
USEPA · Jul 22, 2020 · 662277c · 662277c
2 parents c533969 + 8c38878
commit 662277c
Show file tree

Hide file tree

Showing 9 changed files with 345 additions and 341 deletions.
diff --git a/User_Manual/docs/analysis_algorithms.rst → User_Manual/docs/12_analysis_algorithms.rst b/User_Manual/docs/analysis_algorithms.rst → User_Manual/docs/12_analysis_algorithms.rst
diff --git a/User_Manual/docs/12_questions.rst → User_Manual/docs/13_questions.rst b/User_Manual/docs/12_questions.rst → User_Manual/docs/13_questions.rst
diff --git a/User_Manual/docs/3_network_model.rst b/User_Manual/docs/3_network_model.rst
@@ -152,7 +152,7 @@ Physical Components
     .. note::
        The pressure-flow relation at a junction defined by an emitter
        should not be confused with the pressure-demand relation when
-       performing a pressure driven analysis (PDA). See :ref:`Pressure Driven Demand<press_driven_analysis>`
+       performing a pressure driven analysis (PDA). See :ref:`Hydraulic Simulation Model<sec-hyd_sim_model>`
        for more information.
 
 **Pipes**
@@ -850,23 +850,25 @@ Hydraulic Simulation Model
    than normal will occur automatically whenever one of the following
    events occurs:
 
-    -  The next output reporting time period occurs
-    -  The next time pattern period occurs
-    -  A tank becomes empty or full
-    -  A simple control or rule-based control is activated
-
-	EPANET's hydraulic analysis allows for two different ways of modeling water demands (i.e., consumption) 
-	at network junction nodes. Demand Driven Analysis (DDA) requires that demands at each point in time are 
-	fixed values that must be delivered no matter what nodal pressures and link flows are produced by a 
-	hydraulic solution. This has been the classical approach used to model demands, but it can result in 
-	situations where required demands are satisfied at nodes with negative pressures - a physical impossibility. 
-	An alternative approach, known as Pressure Driven Analysis (PDA), allows the actual demand delivered at a 
-	node to depend on the node's pressure. Below some minimum pressure demand is zero, above some service pressure 
-	the full required demand is supplied and in between demand varies as a power law function of pressure. Using 
-	PDA is one way to avoid having positive demands at nodes with negative pressures.  
-
-	EPANET's Hydraulic Analysis Options are used to select a choice of demand model and to supply the parameters used by PDA.
+     -  The next output reporting time period occurs
+
+     -  The next time pattern period occurs
+
+     -  A tank becomes empty or full 
 
+     -  A simple control or rule-based control is activated
+
+   EPANET's hydraulic analysis allows for two different ways of modeling water demands (i.e., consumption) at network junction nodes. 
+   Demand Driven Analysis (DDA) requires that demands at each point in time are fixed values that must 
+   be delivered no matter what nodal pressures and link flows are produced by a hydraulic solution. This 
+   has been the classical approach used to model demands, but it can result in situations where required
+   demands are satisfied at nodes with negative pressures - a physical impossibility. An alternative 
+   approach, known as Pressure Driven Analysis (PDA), allows the actual demand delivered at a node to 
+   depend on the node's pressure. Below some minimum pressure demand is zero, above some service pressure 
+   the full required demand is supplied and in between demand varies as a power law function of pressure. Using 
+   PDA is one way to avoid having positive demands at nodes with negative pressures.  
+
+   EPANET's :ref:`Hydraulic Analysis Options<table-hyd_ops>` are used to select a choice of demand model and to supply the parameters used by PDA.
 
 .. _sec-wq_sim_model:
 
@@ -907,6 +909,7 @@ Water Quality Simulation Model
    re-ordered from front to back.
 
 **Water Quality Sources**
+
 	Water quality sources are nodes where the quality of external flow entering 
 	the network is specified. They can represent the main treatment works, a 
 	well-head or satellite treatment facility, or an unwanted contaminant intrusion. 

diff --git a/User_Manual/docs/8_analyzing_network.rst b/User_Manual/docs/8_analyzing_network.rst
diff --git a/User_Manual/docs/conf.py b/User_Manual/docs/conf.py
@@ -15,7 +15,7 @@
 #import os
 #import sys
 #sys.path.insert(0, os.path.abspath('.'))
-
+import sphinx_rtd_theme
 
 # -- Project information -----------------------------------------------------
 
@@ -46,6 +46,7 @@
 extensions = ['sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
+    "sphinx_rtd_theme",
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
     'sphinx.ext.mathjax',

diff --git a/User_Manual/docs/front_matter.rst b/User_Manual/docs/front_matter.rst
@@ -20,13 +20,13 @@
 This manual describes how to run version 2.2 of the EPANET water distribution 
 system simulation model. Notable improvements made by this version include:
 
-- the ability to use pressure-dependent demands in hydraulic analyses
-- an option to allow full tanks to overflow
-- options that insure a more accurate hydraulic analysis is made
-- more robust handling of low and zero flow hydraulic conditions
-- faster solution times for single period hydraulic analyses
-- improved mass balance results for water quality analyses
-- an enhanced API function library for customizing EPANET (see http://wateranalytics.org/EPANET/).
+- The ability to use pressure-dependent demands in hydraulic analyses.
+- An option to allow full tanks to overflow.
+- Options that insure a more accurate hydraulic analysis is made.
+- More robust handling of low and zero flow hydraulic conditions.
+- Faster solution times for single period hydraulic analyses.
+- Improved mass balance results for water quality analyses.
+- An enhanced API function library for customizing EPANET (see http://wateranalytics.org/EPANET/).
 
 The following topics are covered in this Manual:
 
@@ -93,15 +93,13 @@ coefficients, etc.). It also discusses how to save a project’s entire
 database to a readable text file and how to export the network map to
 a variety of formats.
 
+:ref:`analysis_algorithms` provides details of the procedures and
+formulas used by EPANET in its hydraulic and water quality analysis algorithms.
+
 :ref:`questions` answers questions about how EPANET can be used
 to model special kinds of situations, such as modeling pneumatic tanks,
 finding the maximum flow available at a specific pressure, and
 modeling the growth of disinfection by-products.
-
-:ref:`analysis_algorithms` provides details of the procedures and
-formulas used by EPANET in its hydraulic and water quality analysis algorithms.
-
-
 The manual also contains several appendixes.
 
 | :ref:`units` provides a table of units of expression for all

diff --git a/User_Manual/docs/index.rst b/User_Manual/docs/index.rst
@@ -26,8 +26,8 @@
    9_viewing_results
    10_printing_copying
    11_importing_exporting
-   12_questions
-   analysis_algorithms
+   12_analysis_algorithms
+   13_questions  
    references
 
 .. toctree:: 

diff --git a/User_Manual/docs/index_latex.rst b/User_Manual/docs/index_latex.rst
@@ -19,7 +19,7 @@ EPANET documentation
    9_viewing_results
    10_printing_copying
    11_importing_exporting
-   12_questions
-   analysis_algorithms
+   12_analysis_algorithms
+   13_questions  
    references
 
diff --git a/User_Manual/docs/references.rst b/User_Manual/docs/references.rst
@@ -18,7 +18,7 @@ Bhave, P. R. 1991. *Analysis of Flow in Water Distribution Networks*.
 Technomic Publishing. Lancaster, PA.
 
 Clark, R. M. 1998. “Chlorine demand and Trihalomethane formation
-kinetics: a second-order model”, *Jour. Env. Eng*., Vol. 124, No. 1,
+kinetics: a second-order model”, *J. Environ. Eng*., Vol. 124, No. 1,
 pp. 16-24.
 
 Davis, M. J., Janke, R., and Taxon, T. N. 2018. "Mass imbalances in 
@@ -43,23 +43,23 @@ algorithm by multiple elimination". *ACM Transactions on Mathematical
 Software*, 11(2), 141-153
 
 Notter, R. H. and Sleicher, C. A. 1971. “The eddy diffusivity in the
-turbulent boundary layer near a wall”, *Chem. Eng. Sci.,* Vol. 26,
+turbulent boundary layer near a wall”, *Chem. Eng. Sci*., Vol. 26,
 pp. 161-171.
 
 Rossman, L. A., Boulos, P. F., and Altman, T. (1993). “Discrete
 volume-element method for network water-quality models”, *J. Water
-Resour. Plng. and Mgmt*, Vol. 119, No. 5, 505-517.
+Resour. Plan. and Manage*., Vol. 119, No. 5, 505-517.
 
 Rossman, L. A., Clark, R. M., and Grayman, W. M. (1994). “Modeling
-chlorine residuals in drinking-water distribution systems”, *Jour.
-Env. Eng*., Vol. 120, No. 4, 803-820.
+chlorine residuals in drinking-water distribution systems”, *J.
+Environ. Eng*., Vol. 120, No. 4, 803-820.
 
 Rossman, L. A. and Boulos, P. F. (1996). “Numerical methods for
 modeling water quality in distribution systems: A comparison”, *J.
-Water Resour. Plng. and Mgmt*, Vol. 122, No. 2, 137-146.
+Water Resour. Plan. and Manage*., Vol. 122, No. 2, 137-146.
 
 Rossman, L. A. and Grayman, W. M. 1999. “Scale-model studies of mixing
-in drinking water storage tanks”, *Jour. Env. Eng*., Vol. 125, No. 8,
+in drinking water storage tanks”, *J. Environ. Eng*., Vol. 125, No. 8,
 pp. 755-761.
 
 Todini E. and Pilati S. (1988). “A gradient method for the solution 
@@ -69,8 +69,8 @@ and Simulation, John Wiley & Sons, pp. 1-20.
 
 Todini E. and Rossman L.A. (2013). “Unified Framework for Deriving 
 Simultaneous Equation Algorithms for Water Distribution Networks.” 
-J. Hydraul. Eng., 139(5), 511-526.
+*J. Hydraul. Eng*., 139(5), 511-526.
 
 Wagner, J. M., Shamir, U., and Marks, D. H. 1988. "Water distribution
-reliability: Simulation methods." *Jour. Water Resour. Plan. Manage*.,
+reliability: Simulation methods." *J. Water Resour. Plan. Manage*.,
 Vol. 114, No. 3, 253-275.