Some documentation cleanup

documentation/acronyms.rst

@@ -12,24 +12,46 @@
 Abbreviations
 ======================================
 
-**API**: Application programming interface
+**AML**: algebraic modeling system
 
-**CSV**: Comma-separated values 
+**API**: application programming interface
+
+**CRS**: coordinate reference system
+
+**CSV**: comma-separated values 
+
+**DD**: demand-driven `(DDA now the preferred term)`
+
+**DDA**: demand-driven analysis
 
 **EPA**: Environmental Protection Agency
 
-**GIS**: Geographic information system
+**EPANET**: a water network modeling tool, see :cite:t:`ross00` and :cite:t:`rwts20`
+
+**GIS**: geographic information system
 
 **HDF**: Hierarchical Data Format
 
-**IDE**: Integrated development environment
+**IDE**: integrated development environment
+
+**INP file**: a text input file for EPANET
+
+**I/O**: input and output
 
 **JSON**: JavaScript Object Notation
 
+**PDA**: pressure-driven analysis
+
+**PDD**: pressure dependent demand `(PDA now the preferred term)`
+
+**SCADA**: supervisory control And data acquisition
+
 **SI**: International System of Units
 
 **SQL**: Structured Query Language
 
 **US**: United States
 
+**UTM**: Universal Transverse Mercator
+
 **WNTR**: Water Network Tool for Resilience

documentation/index.rst

@@ -2,11 +2,16 @@
    :scale: 10 %
    :alt: Logo
 
+========================================
 Water Network Tool for Resilience (WNTR)
 ========================================
 
 The Water Network Tool for Resilience (WNTR) is an EPANET compatible Python package 
 designed to simulate and analyze resilience of water distribution networks.
+The official WNTR software repository is in the U.S. EPA's GitHub repository
+(https://github.com/USEPA/WNTR); releases are also made available via PyPI and conda-forge
+(see :ref:`installation`).
+
 
 .. toctree::
    :maxdepth: 1
@@ -16,8 +21,8 @@ designed to simulate and analyze resilience of water distribution networks.
    wntr-api
    users
 
-.. rubric:: Citing WNTR
-
+Citing WNTR
+===========
 To cite WNTR, use one of the following references:
 
 * Klise, K.A., Hart, D.B., Bynum, M., Hogge, J., Haxton, T., Murray, R., Burkhardt, J. (2020). Water Network Tool for Resilience (WNTR) User Manual: Version 0.2.3. U.S. EPA Office of Research and Development, Washington, DC, EPA/600/R-20/185, 82p.
@@ -26,11 +31,9 @@ To cite WNTR, use one of the following references:
 
 * Klise, K.A., Bynum, M., Moriarty, D., Murray, R. (2017). A software framework for assessing the resilience of drinking water systems to disasters with an example earthquake case study, Environmental Modelling and Software, 95, 420-431, doi: 10.1016/j.envsoft.2017.06.022
 
-Legal notices
-=============
 
 US EPA Disclaimer
------------------
+=================
 
 The U.S. Environmental Protection Agency through its Office of Research and Development funded and collaborated 
 in the research described here under an Interagency Agreement with the Department of Energy's Sandia National Laboratories.
@@ -39,18 +42,9 @@ the contents necessarily reflect the views of the Agency. Mention of trade names
 EPA approval, endorsement, or recommendation.  
 
 Sandia Funding Statement
-------------------------
+========================
 
 Sandia National Laboratories is a multimission laboratory managed and operated by National Technology and 
 Engineering Solutions of Sandia, LLC., a wholly owned subsidiary of Honeywell International, Inc., for the 
 U.S. Department of Energy's National Nuclear Security Administration under contract DE-NA-0003525.
 
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
-

documentation/installation.rst

@@ -2,6 +2,8 @@
 
     \clearpage
 
+.. _installation:
+
 Installation
 ======================================
 .. include:: <isonum.txt>

documentation/resultsobject.rst

@@ -194,7 +194,7 @@ Network and time series graphics can be customized to add titles, legends, axis
 
 Pandas includes methods to write DataFrames to the following file formats:
 
-* Excel
+* Microsoft Excel (xlsx)
 * Comma-separated values (CSV)
 * Hierarchical Data Format (HDF)
 * JavaScript Object Notation (JSON)

documentation/units.rst

@@ -7,23 +7,23 @@ Units
 
 All data in WNTR is stored in the following SI (International System) units:
 
-* Acceleration = :math:`g` (1 :math:`g` = 9.81 :math:`m/s^2`)
-* Concentration = :math:`kg/m^3`
-* Demand = :math:`m^3/s`
-* Diameter = :math:`m`
-* Elevation = :math:`m`
-* Energy = :math:`J`
-* Flow rate = :math:`m^3/s`
-* Head = :math:`m` 
-* Headloss = :math:`m` 
-* Length = :math:`m`
-* Mass = :math:`kg`
-* Mass injection = :math:`kg/s`
-* Power = :math:`W`
-* Pressure head = :math:`m` (this assumes a fluid density of 1000 :math:`kg/m^3`)
-* Time = :math:`s`
-* Velocity = :math:`m/s`
-* Volume = :math:`m^3`
+* Acceleration = :math:`\rm g` (:math:`\rm g \equiv 9.80665 m/s^2`)
+* Concentration = :math:`\rm kg/m^3`
+* Demand = :math:`\rm m^3/s`
+* Diameter = :math:`\rm m`
+* Elevation = :math:`\rm m`
+* Energy = :math:`\rm J`
+* Flow rate = :math:`\rm m^3/s`
+* Head = :math:`\rm m` 
+* Headloss = :math:`\rm m` 
+* Length = :math:`\rm m`
+* Mass = :math:`\rm kg`
+* Mass injection = :math:`\rm kg/s`
+* Power = :math:`\rm W`
+* Pressure head = :math:`\rm m` (assumes a fluid density of 1000 :math:`\rm kg/m^3`)
+* Time = :math:`\rm s`
+* Velocity = :math:`\rm m/s`
+* Volume = :math:`\rm m^3`
 
 When setting up analysis in WNTR, all input values should be specified in SI units. 
 All simulation results are also stored in SI units and can be converted to other units if desired, 
@@ -90,7 +90,7 @@ For reference, :numref:`table-epanet-units` includes EPANET unit conventions :ci
    | Reaction             | - *mass* /ft/day (0-order)          | - *mass* /m/day (0-order)          |
    | coefficient (Wall)   | - ft/day (1st-order)                | - m/day (1st-order)                |
    +----------------------+-------------------------------------+------------------------------------+
-   | Roughness            | - 10 :sup:`-3` ft (Darcy-Weisbach)  | - mm (Darcy-Weisbach)              |
+   | Roughness            | - 0.001 ft (Darcy-Weisbach)         | - mm (Darcy-Weisbach)              |
    | coefficient          | - unitless (otherwise)              | - unitless (otherwise)             |
    +----------------------+-------------------------------------+------------------------------------+
    | Source mass          |   *mass* /min                       | *mass* /min                        |

documentation/wntr-api.rst

@@ -25,10 +25,3 @@ API documentation
         wntr.scenario
         wntr.sim
         wntr.utils
-
-.. toctree::
-    :caption: Appendices
-    :hidden:
-
-    acronyms
-    reference