search

ImperialCollegeLondon / SWMManywhere

SWMManywhere is used to derive and simulate a sewer network anywhere in the world
https://imperialcollegelondon.github.io/SWMManywhere/
BSD 3-Clause "New" or "Revised" License
4 stars 1 forks source link

update readme #260

Closed barneydobson closed 2 months ago

barneydobson commented 2 months ago

Description

first attempt of simple readme

barneydobson commented 2 months ago

Good starting point, but I think this will need:

  1. A minimal example of usage using the CLI
  2. A minimal example of output results, eg. a plot, illustrating the capabilities.

Nothing complex or thorough - that's what the documentation is for - just something to catch the attention of the reader.

@dalonsoa the quickstart guide in the documentation provides exactly these things... should I also include that in the readme?

dalonsoa commented 2 months ago

No, no. Way simpler than the Quickstart. Quite literally:

Once installed, you can simply run SWMManywhere from the command line giving a settings file in TOML format as input. As SWMManywhere can download most of the data automatically from well known sources, this settings file can often be minimal and restricted to indicating the geographical area to be processed:

SWMManywhere settings.toml

The result of the calculation will be a design of the sewage system for that area, like the following, which can then be further processed or analysed with XXXX, for example:

(image of a map with calculated sewages)

Follow the Quickstart for a more detailed initial example and read the Documentation for full information of SWMManywhere capabilities.

dalonsoa commented 2 months ago

It would be great to see how to do things with conda-forge. I've zero experience with it.