Skip to content

Commit

Permalink
Updates to MSX documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dbhart committed Nov 18, 2024
1 parent 1c3279f commit be18e35
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions documentation/waterquality_msx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ There are two different types of coefficients that can be used in reaction expre
and **parameters**. Constants have a single value in every expression. Parameters have a global value
that is used by default, but which can be modified on a per-pipe or per-tank basis.

Pre-defined hydraulic variable can be found in
Pre-defined hydraulic variables can be found in
the EPANET-MSX documentation, and are also defined in WNTR as :attr:`~wntr.msx.base.HYDRAULIC_VARIABLES`.

Reactions
Expand All @@ -80,11 +80,11 @@ WNTR also contains a library of MSX models that are accessed through the
:class:`~wntr.msx.library.ReactionLibrary`.
This includes the following models:

* `Arsenic oxidation/adsorption <https://github.com/dbhart/WNTR/blob/msx/wntr/msx/_library_data/arsenic_chloramine.json>`_ :cite:p:`shang2023`
* `Batch chloramine decay <https://github.com/dbhart/WNTR/blob/msx/wntr/msx/_library_data/batch_chloramine_decay.json>`_
* `Lead plumbosolvency <https://github.com/dbhart/WNTR/blob/msx/wntr/msx/_library_data/lead_ppm.json>`_ :cite:p:`bwms20`
* `Nicotine/chlorine reaction <https://github.com/dbhart/WNTR/blob/msx/wntr/msx/_library_data/nicotine.json>`_
* `Nicotine/chlorine reaction with reactive intermediate <https://github.com/dbhart/WNTR/blob/msx/wntr/msx/_library_data/nicotine_ri.json>`_
* `Arsenic oxidation/adsorption <https://github.com/USEPA/WNTR/blob/msx/wntr/msx/_library_data/arsenic_chloramine.json>`_ :cite:p:`shang2023`
* `Batch chloramine decay <https://github.com/USEPA/WNTR/blob/msx/wntr/msx/_library_data/batch_chloramine_decay.json>`_
* `Lead plumbosolvency <https://github.com/USEPA/WNTR/blob/msx/wntr/msx/_library_data/lead_ppm.json>`_ :cite:p:`bwms20`
* `Nicotine/chlorine reaction <https://github.com/USEPA/WNTR/blob/msx/wntr/msx/_library_data/nicotine.json>`_
* `Nicotine/chlorine reaction with reactive intermediate <https://github.com/USEPA/WNTR/blob/msx/wntr/msx/_library_data/nicotine_ri.json>`_

The models are stored in JSON format.
Additional models can be loaded into the library by setting a user specified path.
Expand Down
6 changes: 3 additions & 3 deletions examples/demos/multisource-cl-decay.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
"The amount of free chlorine is based on the rate reaction:\n",
"\n",
"$$\n",
" \\frac{d}{dt}\\mathrm{Cl_2} = -(k_1 T + k_2(1-T)) \\mathrm{Cl_2}\n",
" \\frac{d}{dt}\\mathrm{Cl_2} = -(k_1 T_1 + k_2(1-T_1)) \\mathrm{Cl_2}\n",
"$$"
]
},
Expand Down Expand Up @@ -370,7 +370,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
Expand All @@ -384,7 +384,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.5"
"version": "3.12.5"
}
},
"nbformat": 4,
Expand Down

0 comments on commit be18e35

Please sign in to comment.