Waterways

These options control behaviour of the waterways inclusion stage and are all grouped under the waterways key-value.

The waterways sub-section within the waterways key is required if incorporating drains from Open Street Map (OSM).

• source [Optional, str, default osm] - The source of the waterways network. Currently only OpenStreetMaps (osm) and 'file' are supported.

• widths [Required, dict] - The widths respectively assumed for the OSM drains, streams and rivers. i.e. {"drain": 5, "stream": 7.5, "river": 10}. Note the rivers entry is optional. If it is omitted all rivers are ignored. In the case of a 'file' this can also be a single float applied to all entries.

• osm_date [Optional, str] - If specified, this is used in the OSM query for waterways to query for OSM objects that existed at the specified date. An valid example is 2013-01-01T00:00:00Z.

Stopbanks

These options control behaviour of the stopbanks inclusion stage and are all grouped under the stopbanks key-value.

The waterways sub-section within the `waterways~key is required if incorporating drains from Open Street Map (OSM).

• source [Optional, str, default file] - The source of the stopbanks network. Currently only OpenStreetMaps (osm) and file are supported.

• width [Required, float] - The width assumed for all stopbanks.

• osm_date [Optional, str] - If specified, this is used in the OSM query for waterways to query for OSM objects that existed at the specified date. An valid example is 2013-01-01T00:00:00Z.