Added example with pyswmm and swmmio, incluiding animation

pyswmm · Dec 19, 2024 · 83ef132 · 83ef132
1 parent 4c7f769
commit 83ef132
Show file tree

Hide file tree

Showing 4 changed files with 8,350 additions and 7 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -212,4 +212,10 @@
 epub_exclude_files = ['search.html']
 
 
-numpydoc_class_members_toctree = False
+numpydoc_class_members_toctree = False
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
+    "pyswmm": ("https://pyswmm.github.io/pyswmm/", None),
+}
diff --git a/docs/index.ipynb b/docs/index.ipynb
@@ -13,7 +13,7 @@
     "## Introduction\n",
     "`swmmio` is a Python tool for engineers and hydrologists who need to supercharge their ability to modify and analyze EPA SWMM models and results. Using a familiar Pandas interface, users can replace manual procesess that used to live in spreadsheets with scripts and automation.\n",
     "\n",
-    "The core {py:class}`~swmmio.core.Model` object provides accessors to related elements in the INP and RPT. For example, the {py:obj}`Model.subcatchments <swmmio.core.Model.subcatchments>` property provides a DataFrame (or GeoDataFrame) accessor joining data from the `[SUBCATCHMENTS]` and `[SUBAREAS]` tables in the model.inp file and, if available, the `Subcatchment Runoff Summary` from the model.rpt file. \n",
+    "The core {py:class}`~swmmio.core.Model` object provides accessors to related elements in the INP and RPT. For example, the {py:obj}`Model.subcatchments <swmmio.core.Model.subcatchments>` property provides a {py:obj}`~pandas.DataFrame` (or GeoDataFrame) accessor joining data from the `[SUBCATCHMENTS]` and `[SUBAREAS]` tables in the model.inp file and, if available, the `Subcatchment Runoff Summary` from the model.rpt file. \n",
     "\n",
     "Additionally, `swmmio` provides a lower-level {py:class}`~swmmio.core.inp` API for reading and writing (almost) all of the sections of the model.inp file which is useful for programmatically modifying EPA SWMM models.\n",
     "\n",
@@ -26,11 +26,6 @@
     "For more examples and tutorials, see the [User Guide](usage/index.md) section."
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": []
-  },
   {
    "cell_type": "code",
    "execution_count": null,

diff --git a/docs/usage/getting_started.ipynb b/docs/usage/getting_started.ipynb
@@ -119,6 +119,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "## Edit Model Parameters\n",
+    "\n",
     "Now let's use the lower-level {py:obj}`Model.inp <swmmio.core.inp>` API to access and modify the sections of the model. We'll change the outfall type to FIXED and set a stage elevation. \n",
     "\n",
     ":::{note}\n",

diff --git a/docs/usage/working_with_pyswmm.ipynb b/docs/usage/working_with_pyswmm.ipynb