diff --git a/documentation/attention.rst b/documentation/attention.rst index f8dd67b1..3c9680b2 100644 --- a/documentation/attention.rst +++ b/documentation/attention.rst @@ -4,10 +4,10 @@ for more information. .. _fig-factsheet: -.. figure:: factsheets/WNTR_factsheet.png +.. figure:: factsheets/WNTR_overview_factsheet.png :width: 250 :alt: WNTR factsheet -Download the :download:`WNTR overview factsheet ` - -Download the :download:`WNTR case studies factsheet ` +:download:`WNTR overview factsheet ` + +:download:`WNTR case studies factsheet ` diff --git a/documentation/data_requirements.rst b/documentation/data_requirements.rst deleted file mode 100644 index 805162ff..00000000 --- a/documentation/data_requirements.rst +++ /dev/null @@ -1,27 +0,0 @@ -Data requirements -=================== - -WNTR requires a model of the water distribution system. -That model can be obtained from the water utility (in EPANET INP or related file format) -or be generated from data. The basic features of the model are shown in :numref:`fig-data-req` -and breifly described in :numref:`table-data-req`. -Some information can be approximated from publicly -available data sources, as outlined in the table. - -For more information on water distribution system models, see the -the `EPANET 2.2 online user manual `_, and -EPA’s website on `Small System Challenges and Solutions `_. -The 2020 presentation includes an overview of hydraulic modeling. - -.. _fig-data-req: -.. figure:: figures/data_requirements.png - :width: 320 - :alt: Network - - Physical components in a water distribution system model (from EPANET 2.2 online user manual) - -.. _table-data-req: -.. csv-table:: Water distribution system model data requirements - :file: tables/data_requirements.csv - :widths: 10, 15, 15, 25, 25 - :header-rows: 1 diff --git a/documentation/factsheets/WATER INFRASTRUCTURE RESILIENCE EVALUATION USING WNTR.PDF b/documentation/factsheets/WNTR_case_studies_factsheet.pdf similarity index 100% rename from documentation/factsheets/WATER INFRASTRUCTURE RESILIENCE EVALUATION USING WNTR.PDF rename to documentation/factsheets/WNTR_case_studies_factsheet.pdf diff --git a/documentation/factsheets/WNTR_data_factsheet.pptx b/documentation/factsheets/WNTR_data_factsheet.pptx new file mode 100644 index 00000000..42d6b4f0 Binary files /dev/null and b/documentation/factsheets/WNTR_data_factsheet.pptx differ diff --git a/documentation/factsheets/WNTR_factsheet.pdf b/documentation/factsheets/WNTR_overview_factsheet.pdf similarity index 100% rename from documentation/factsheets/WNTR_factsheet.pdf rename to documentation/factsheets/WNTR_overview_factsheet.pdf diff --git a/documentation/factsheets/WNTR_factsheet.png b/documentation/factsheets/WNTR_overview_factsheet.png similarity index 100% rename from documentation/factsheets/WNTR_factsheet.png rename to documentation/factsheets/WNTR_overview_factsheet.png diff --git a/documentation/factsheets/WNTR_factsheet.pptx b/documentation/factsheets/WNTR_overview_factsheet.pptx similarity index 100% rename from documentation/factsheets/WNTR_factsheet.pptx rename to documentation/factsheets/WNTR_overview_factsheet.pptx diff --git a/documentation/factsheets/WNTR_tutorials.pptx b/documentation/factsheets/WNTR_tutorials_factsheet.pptx similarity index 98% rename from documentation/factsheets/WNTR_tutorials.pptx rename to documentation/factsheets/WNTR_tutorials_factsheet.pptx index 47ebf26b..69a8f6fe 100644 Binary files a/documentation/factsheets/WNTR_tutorials.pptx and b/documentation/factsheets/WNTR_tutorials_factsheet.pptx differ diff --git a/documentation/tables/data_requirements.csv b/documentation/tables/data_requirements.csv deleted file mode 100644 index b860df85..00000000 --- a/documentation/tables/data_requirements.csv +++ /dev/null @@ -1,31 +0,0 @@ -Component,Definition,Requirement,Attributes,Approximations -Junctions,"Junctions are nodes that connect links (pipes, pumps, and valves)",Required to connect components,"* Location* - -\* Location for all components includes the X and Y position along with elevation. X and Y can be in any coordinate system. WNTR uses SI units for all other attributes.","The location of junctions can be inferred from link start and end location - -Elevation (for all components) can be determined using digital elevation maps." -Demand points,"Demand points are junctions that also include water withdrawal - -Demand points can represent an individual household/building, a neighborhood, a zip code, or a census block",All models include demand,"* Location -* Base demand rate (volume per time) -* Demand pattern - -Demand patterns define how water is used throughout the day. Different patterns can be defined for summer and winter.","Demand location and base value can be approximated in several ways, for example from open-source data on building footprints - -General demand patterns can be used (i.e., peak mid-day for commercial use or peak morning and evening for residential use)" -Reservoir,"Reservoirs are nodes that define the water source, generally the water treatment plant",All models must contain at least one source,"* Location -* Pressure",Location is generally known or can be estimated using online maps of the region. Pressure can be estimated if needed. -Tanks,Tanks are nodes with storage capacity ,Not required,"* Location -* Min and max water level -* Diameter",Tank location and size can sometimes be approximated from satellite images -Pipes,"Pipes are links that connect nodes (junctions, reservoirs, and tanks)",Required to connect components,"* Start and end location -* Diameter -* Material or roughness","Since pipes generally follow streets, the location of pipes can be approximated using open-source street data. Attributes like diameter and roughness can be estimated if needed." -Pumps,Pumps are links that raise the hydraulic head,Not required if the system is gravity fed,"* Location and direction -* Operational settings (pump curve) -* Controls (pump schedule)",Pump attributes are difficult to approximate without guidance from the utility -Valves,Valves are links that limit the pressure or flow,"While most systems include valves, they are not always included in the model","* Location and direction -* Type (pressure reducing valve, flow control valve, etc.) -* Operational setting (pressure or flow) -* Status (open or closed) -* Controls (schedule to change setting/status)",Valve attributes are difficult to approximate without guidance from the utility diff --git a/documentation/userguide.rst b/documentation/userguide.rst index 7155fffb..2da03605 100644 --- a/documentation/userguide.rst +++ b/documentation/userguide.rst @@ -8,6 +8,10 @@ User Guide The Water Network Tool for Resilience (WNTR) is an EPANET compatible Python package designed to simulate and analyze resilience of water distribution networks. +:download:`WNTR overview factsheet ` + +:download:`WNTR case studies factsheet ` + US EPA Disclaimer ----------------- @@ -34,7 +38,6 @@ U.S. Department of Energy's National Nuclear Security Administration under contr framework units getting_started - data_requirements examples .. toctree::