Skip to content

Commit

Permalink
improve clarity of API references in getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
aerispaha committed Dec 19, 2024
1 parent ce8ccf7 commit 4c7f769
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions docs/usage/getting_started.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@
},
"source": [
"# Getting Started\n",
"To get started with `swmmio`, you'll need a EPA SWMM input file (.inp). We'll usae an example model provided within `swmmio` and see what it looks like to get a {py:meth}`swwmio.core.Model.links` DataFrame, "
"To get started with `swmmio`, you'll need a EPA SWMM input file (.inp). We'll use an example model provided within `swmmio` and see what it looks like to get a {py:obj}`Model.links <swmmio.core.Model.links>` DataFrame, "
]
},
{
"cell_type": "code",
"execution_count": 1,
"execution_count": 3,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -99,7 +99,7 @@
"[3 rows x 26 columns]"
]
},
"execution_count": 1,
"execution_count": 3,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -119,10 +119,10 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Now let's use the lower-level {py:obj}`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",
"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",
"The {py:class}`swmmio.core.inp` API has coverage for almost all sections of the INP file. If you find that a section isn't covered that you need, raise an issue [here](https://github.com/pyswmm/swmmio/issues)!\n",
"The {py:class}`Model.inp <swmmio.core.inp>` API has coverage for almost all sections of the INP file. If you find that a section isn't covered that you need, raise an issue [here](https://github.com/pyswmm/swmmio/issues)!\n",
":::"
]
},
Expand Down Expand Up @@ -261,7 +261,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"We can then save our updated model to a new .inp file, then instantiate a new {py:class}`swmmio.core.Model` object. "
"We can then save our updated model to a new .inp file, then instantiate a new {py:class}`~swmmio.core.Model` object. "
]
},
{
Expand Down Expand Up @@ -621,7 +621,7 @@
"metadata": {},
"source": [
"## Access Model Network as Graph\n",
"The {py:obj}`swmmio.core.Model` class returns a Networkx MultiDiGraph representation of the model via that {py:meth}`swmmio.core.Model.network` parameter:"
"The {py:obj}`~swmmio.core.Model` class returns a Networkx MultiDiGraph representation of the model via that {py:meth}`Model.network <swmmio.core.Model.network>` parameter:"
]
},
{
Expand Down Expand Up @@ -702,11 +702,15 @@
"python -m swmmio -sp Model_Dir1 Model_Dir2 -cores_left=1\n",
"```\n",
"\n",
"<div class=\"warning\">\n",
" <p class=\"first admonition-title\">Warning</p>\n",
" <p class=\"last\">Using all cores for simultaneous model runs can put your machine's CPU usage at 100% for extended periods of time. This probably puts stress on your hardware. Use at your own risk.</p>\n",
"</div>\n"
":::{warning}\n",
"Using all cores for simultaneous model runs can put your machine's CPU usage at 100% for extended periods of time. This probably puts stress on your hardware. Use at your own risk.\n",
":::\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": []
}
],
"metadata": {
Expand Down

0 comments on commit 4c7f769

Please sign in to comment.