diff --git a/docs/usage/working_with_pyswmm.ipynb b/docs/usage/working_with_pyswmm.ipynb index 7cd17ae..d9a03b2 100644 --- a/docs/usage/working_with_pyswmm.ipynb +++ b/docs/usage/working_with_pyswmm.ipynb @@ -8,12 +8,12 @@ "\n", "If we _really_ want to supercharge our modeling workflow, we can tap into the excellent functionality provided by [pyswmm](https://www.pyswmm.org/). Here we'll walk through a simple example that runs a model with pyswmm and post-processes the results with `swmmio`.\n", "\n", - "We'll start by opening a {py:obj}`pyswmm.Simulation` context to run a model. Then we'll visualize the results using the {py:func}`swmmio.create_map` function.\n" + "We'll start by instantiating a `swmmio.Model` with a model hosted in the swmm-nrtestsuite repo." ] }, { "cell_type": "code", - "execution_count": 106, + "execution_count": 5, "metadata": {}, "outputs": [ { @@ -30,7 +30,7 @@ " 'invert_range': np.int64(35)}" ] }, - "execution_count": 106, + "execution_count": 5, "metadata": {}, "output_type": "execute_result" } @@ -43,208 +43,19 @@ "# path to a SWMM model from swmm-nrtestsuite\n", "model_path = 'https://raw.githubusercontent.com/USEPA/swmm-nrtestsuite/refs/heads/dev/public/examples/Example1.inp'\n", "model = swmmio.Model(model_path)\n", - "model.summary\n" + "model.summary" ] }, { - "cell_type": "code", - "execution_count": 28, + "cell_type": "markdown", "metadata": {}, - "outputs": [ - { - "data": { - "text/html": [ - "
\n", - " | InletNode | \n", - "OutletNode | \n", - "... | \n", - "MaxDPerc | \n", - "coords | \n", - "
---|---|---|---|---|---|
Name | \n", - "\n", - " | \n", - " | \n", - " | \n", - " | \n", - " |
1 | \n", - "9 | \n", - "10 | \n", - "... | \n", - "0.38 | \n", - "[(4042.11, 9600.0), (4105.26, 6947.37)] | \n", - "
4 | \n", - "19 | \n", - "20 | \n", - "... | \n", - "0.22 | \n", - "[(7768.42, 6736.84), (5957.89, 6589.47)] | \n", - "
5 | \n", - "20 | \n", - "21 | \n", - "... | \n", - "0.17 | \n", - "[(5957.89, 6589.47), (4926.32, 6105.26)] | \n", - "
6 | \n", - "10 | \n", - "21 | \n", - "... | \n", - "1.00 | \n", - "[(4105.26, 6947.37), (4926.32, 6105.26)] | \n", - "
7 | \n", - "21 | \n", - "22 | \n", - "... | \n", - "0.29 | \n", - "[(4926.32, 6105.26), (4421.05, 4715.79)] | \n", - "
8 | \n", - "22 | \n", - "16 | \n", - "... | \n", - "0.39 | \n", - "[(4421.05, 4715.79), (4821.05, 3326.32)] | \n", - "
10 | \n", - "17 | \n", - "18 | \n", - "... | \n", - "0.53 | \n", - "[(6252.63, 2147.37), (6673.68, 1368.42), (6631.58, 505.26)] | \n", - "
11 | \n", - "13 | \n", - "14 | \n", - "... | \n", - "0.27 | \n", - "[(2336.84, 4357.89), (3157.89, 4294.74)] | \n", - "
12 | \n", - "14 | \n", - "15 | \n", - "... | \n", - "0.31 | \n", - "[(3157.89, 4294.74), (3221.05, 3242.11)] | \n", - "
13 | \n", - "15 | \n", - "16 | \n", - "... | \n", - "0.76 | \n", - "[(3221.05, 3242.11), (4821.05, 3326.32)] | \n", - "
14 | \n", - "23 | \n", - "24 | \n", - "... | \n", - "0.35 | \n", - "[(6484.21, 3978.95), (5389.47, 3031.58)] | \n", - "
15 | \n", - "16 | \n", - "24 | \n", - "... | \n", - "0.54 | \n", - "[(4821.05, 3326.32), (5389.47, 3031.58)] | \n", - "
16 | \n", - "24 | \n", - "17 | \n", - "... | \n", - "0.57 | \n", - "[(5389.47, 3031.58), (6252.63, 2147.37)] | \n", - "
13 rows × 22 columns
\n", - "