From a4753be63424924af540683105de28540dd04a73 Mon Sep 17 00:00:00 2001 From: barneydobson Date: Wed, 25 Sep 2024 10:57:38 +0100 Subject: [PATCH 1/3] fix links --- README.md | 4 ++-- docs/config_guide.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f107dde0..3a38a3a5 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,9 @@ example: ![SWMM Model](docs/images/andorra_swmm_screenshot.png) -Follow the [Quickstart](https://imperialcollegelondon.github.io/swmmanywhere/quickstart) +Follow the [Quickstart](https://imperialcollegelondon.github.io/SWMManywhere/quickstart) for a more detailed initial example and -[ReadTheDocs](https://imperialcollegelondon.github.io/swmmanywhere/) +[ReadTheDocs](https://imperialcollegelondon.github.io/SWMManywhere/) for full information of SWMManywhere capabilities. diff --git a/docs/config_guide.md b/docs/config_guide.md index fbfdf3a2..b0df8a1e 100644 --- a/docs/config_guide.md +++ b/docs/config_guide.md @@ -87,7 +87,7 @@ data sources beyond those that are provided by default... A user may want to change some of the key data files that underpin SWMManywhere, such as the base `elevation` file (i.e., a DEM from NASADEM) if you have higher resolution data for your region. You can explore the default file structure of a SWMManywhere -project in [link to filepaths page], but a user may provide their own file paths +project at [`FilePaths`](reference-filepaths.md), but a user may provide their own file paths via the config file through the `address_overrides` entry, for example: ```yml @@ -114,7 +114,7 @@ The path to a `subcatchments` geometry file, and a `graph` file (see [`save_graph`](reference-graph-utilities.md#swmmanywhere.graph_utilities.save_graph) for format) must be provided - however this is temporary and will be unnecessary following the fixing of -[this]. +[this](https://github.com/ImperialCollegeLondon/SWMManywhere/issues/84). The user can then provide either an `inp` path to the SWMM `.inp` model file, or if the file has already been run, directly to the `results` file. If a `results` file is provided this will always be used for metric calculation. If From 189e2745e76390f8c789b7e7d38ec89d1447a74f Mon Sep 17 00:00:00 2001 From: barneydobson Date: Wed, 25 Sep 2024 11:00:25 +0100 Subject: [PATCH 2/3] add link --- docs/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index db642e1d..3869ae98 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -43,4 +43,4 @@ If you want to investigate your model in GIS, then the geospatial data that was ## Not happy with your model? Then it sounds like you want to explore the wide range of customisability that SWMManywhere offers! -See our notebooks to understand what is going on in greater detail and how to create better synthetic UDMs. +See our [guides](config_guide.md) to understand what is going on in greater detail and how to create better synthetic UDMs. From f0239c3ea6fb9d8b9238793268455174db39481a Mon Sep 17 00:00:00 2001 From: barneydobson Date: Wed, 25 Sep 2024 11:05:55 +0100 Subject: [PATCH 3/3] add install --- docs/quickstart.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/quickstart.md b/docs/quickstart.md index 3869ae98..ab021fb0 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -3,6 +3,14 @@ SWMManywhere is a Python tool to synthesise Urban Drainage Models (UDM) anywhere in the world. It handles everything from data acquisition to running the UDM in the [SWMM](https://www.epa.gov/sites/default/files/2019-02/documents/epaswmm5_1_manual_master_8-2-15.pdf) software. +## Install SWMManywhere + +Install SWMManywhere: + +```bash +pip install swmmanywhere +``` + ## Run SWMManywhere The intended use of SWMManywhere is via a Command Line Interface (CLI) that receives