Skip to content

Commit

Permalink
shorten and fix links to reference docs on main landing page
Browse files Browse the repository at this point in the history
  • Loading branch information
aerispaha committed Dec 19, 2024
1 parent edd0465 commit 55b810f
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
"## 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, {py:obj}`swmmio.core.Model.subcatchments` provides a DataFrame (or GeoDataFrame) 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 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 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",
"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",
"\n",
"## Installation\n",
Expand All @@ -31,6 +31,13 @@
"metadata": {},
"source": []
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down

0 comments on commit 55b810f

Please sign in to comment.