swmmanywhere 0.1.0__tar.gz

swmmanywhere-0.1.0/.gitignore

@@ -0,0 +1,139 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Pysheds cache
+cache/
+
+# Documentation generated models
+swmmanywhere_models/
+whiteboxtools_binaries.zip
+
+# Hatch
+_version.py

swmmanywhere-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, barneydobson
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

swmmanywhere-0.1.0/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.3
+Name: swmmanywhere
+Version: 0.1.0
+Summary: SWMManywhere software
+Project-URL: Documentation, https://imperialcollegelondon.github.io/SWMManywhere/
+Project-URL: Issues, https://github.com/ImperialCollegeLondon/SWMManywhere/issues
+Project-URL: Source, https://github.com/ImperialCollegeLondon/SWMManywhere
+Author-email: Barnaby Dobson <b.dobson@imperial.ac.uk>, Imperial College London RSE Team <ict-rse-team@imperial.ac.uk>
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: cdsapi
+Requires-Dist: cytoolz
+Requires-Dist: geopandas>=1
+Requires-Dist: geopy
+Requires-Dist: joblib
+Requires-Dist: jsonschema
+Requires-Dist: loguru
+Requires-Dist: netcdf4
+Requires-Dist: networkx>=3
+Requires-Dist: numpy>=2
+Requires-Dist: osmnx>=1.9.3
+Requires-Dist: pandas
+Requires-Dist: planetary-computer
+Requires-Dist: pyarrow
+Requires-Dist: pydantic
+Requires-Dist: pyflwdir
+Requires-Dist: pystac-client
+Requires-Dist: pyswmm
+Requires-Dist: pywbt>=0.2.2
+Requires-Dist: pyyaml
+Requires-Dist: rasterio
+Requires-Dist: rioxarray
+Requires-Dist: scipy
+Requires-Dist: shapely
+Requires-Dist: tqdm
+Requires-Dist: xarray
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pip-tools; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-mock; extra == 'dev'
+Requires-Dist: pytest-mypy; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: doc
+Requires-Dist: mkdocs; extra == 'doc'
+Requires-Dist: mkdocs-coverage; extra == 'doc'
+Requires-Dist: mkdocs-include-markdown-plugin; extra == 'doc'
+Requires-Dist: mkdocs-jupyter; extra == 'doc'
+Requires-Dist: mkdocs-material; extra == 'doc'
+Requires-Dist: mkdocs-material-extensions; extra == 'doc'
+Requires-Dist: mkdocstrings[python]; extra == 'doc'
+Description-Content-Type: text/markdown
+
+# SWMManywhere: Synthesise Urban Drainage Network Models Anywhere in the World
+
+<!-- markdown-link-check-disable -->
+[![Test and build](https://github.com/ImperialCollegeLondon/SWMManywhere/actions/workflows/ci.yml/badge.svg)](https://github.com/ImperialCollegeLondon/SWMManywhere/actions/workflows/ci.yml)
+<!-- markdown-link-check-enable -->
+
+SWMManywhere is a tool to synthesise urban drainage network models (UDMs) using
+publicly available data such as street network, DEM, and building footprints, across
+the globe. It also provides tools for generating SWMM input files and performing
+simulations for the synthesised UDMs.
+
+## Features
+
+- **Automatic data retrieval and preprocessing**: all of our data requirements
+are met with global datasets, so all you need is a bounding box!
+- **Customisable network synthesis**: change a range of parameters to create
+different networks, power users can easily extend existing functionality.
+- **Streamlined evaluation to compare with real networks**: we include a variety
+of performance metrics and automatic running/comparing if you have your own SWMM model.
+- **Command line interface**: All of this and more can be accessed by passing a
+configuration file to a CLI.
+
+## Installation
+
+Install SWMManywhere:
+
+```bash
+pip install swmmanywhere
+```
+
+## Documentation and Quickstart
+
+Once installed, you can simply run SWMManywhere from the command line giving a
+configuration file in YAML format as input. As SWMManywhere can download data
+automatically from well known sources, this settings file can often be minimal and
+restricted to indicating the geographical area to be processed:
+
+`python -m swmmanywhere --config_path=\path\to\config.yml`
+
+The result of the calculation will be a model of the sewage system for that area,
+like the following, which can then be further processed or analysed with SWMM, for
+example:
+
+![SWMM Model](docs/images/andorra_swmm_screenshot.png)
+
+<!-- markdown-link-check-disable -->
+Follow the [Quickstart](https://imperialcollegelondon.github.io/swmmanywhere/quickstart)
+for a more detailed initial example and
+[ReadTheDocs](https://imperialcollegelondon.github.io/swmmanywhere/)
+for full information of SWMManywhere capabilities.
+<!-- markdown-link-check-enable -->
+
+## Use and contributing
+
+This project is licensed under the BSD-3-Clause licence, see [LICENSE](LICENSE).
+
+There are many things we would like to do! If you are interested to contribute
+please see [CONTRIBUTING](docs/CONTRIBUTING.md) and [CODE OF CONDUCT](docs/CODE_OF_CONDUCT.md).

swmmanywhere-0.1.0/README.md

@@ -0,0 +1,58 @@
+# SWMManywhere: Synthesise Urban Drainage Network Models Anywhere in the World
+
+<!-- markdown-link-check-disable -->
+[![Test and build](https://github.com/ImperialCollegeLondon/SWMManywhere/actions/workflows/ci.yml/badge.svg)](https://github.com/ImperialCollegeLondon/SWMManywhere/actions/workflows/ci.yml)
+<!-- markdown-link-check-enable -->
+
+SWMManywhere is a tool to synthesise urban drainage network models (UDMs) using
+publicly available data such as street network, DEM, and building footprints, across
+the globe. It also provides tools for generating SWMM input files and performing
+simulations for the synthesised UDMs.
+
+## Features
+
+- **Automatic data retrieval and preprocessing**: all of our data requirements
+are met with global datasets, so all you need is a bounding box!
+- **Customisable network synthesis**: change a range of parameters to create
+different networks, power users can easily extend existing functionality.
+- **Streamlined evaluation to compare with real networks**: we include a variety
+of performance metrics and automatic running/comparing if you have your own SWMM model.
+- **Command line interface**: All of this and more can be accessed by passing a
+configuration file to a CLI.
+
+## Installation
+
+Install SWMManywhere:
+
+```bash
+pip install swmmanywhere
+```
+
+## Documentation and Quickstart
+
+Once installed, you can simply run SWMManywhere from the command line giving a
+configuration file in YAML format as input. As SWMManywhere can download data
+automatically from well known sources, this settings file can often be minimal and
+restricted to indicating the geographical area to be processed:
+
+`python -m swmmanywhere --config_path=\path\to\config.yml`
+
+The result of the calculation will be a model of the sewage system for that area,
+like the following, which can then be further processed or analysed with SWMM, for
+example:
+
+![SWMM Model](docs/images/andorra_swmm_screenshot.png)
+
+<!-- markdown-link-check-disable -->
+Follow the [Quickstart](https://imperialcollegelondon.github.io/swmmanywhere/quickstart)
+for a more detailed initial example and
+[ReadTheDocs](https://imperialcollegelondon.github.io/swmmanywhere/)
+for full information of SWMManywhere capabilities.
+<!-- markdown-link-check-enable -->
+
+## Use and contributing
+
+This project is licensed under the BSD-3-Clause licence, see [LICENSE](LICENSE).
+
+There are many things we would like to do! If you are interested to contribute
+please see [CONTRIBUTING](docs/CONTRIBUTING.md) and [CODE OF CONDUCT](docs/CODE_OF_CONDUCT.md).

swmmanywhere-0.1.0/netcomp/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

swmmanywhere-0.1.0/netcomp/README.md

@@ -0,0 +1,5 @@
+# NetComp
+
+See [original repo](https://github.com/barneydobson/NetComp) for more details on NetComp.
+
+NetComp is distributed under a MIT license

swmmanywhere-0.1.0/netcomp/__init__.py

@@ -0,0 +1,25 @@
+"""NetComp v0.2.2
+==============
+
+    NetComp is a Python package for comparing networks using pairwise distances,
+    and for performing anomaly detection on a time series of networks. It is
+    built on top of the NetworkX package. For details on usage and installation,
+    see README.md.
+
+"""
+
+from __future__ import annotations
+
+__author__ = "Peter Wills <peter.e.wills@gmail.com>"
+__version__ = "0.2.2"
+__license__ = "MIT"
+
+import sys
+
+if sys.version_info[0] < 3:
+    m = "Python 3.x required (%d.%d detected)."
+    raise ImportError(m % sys.version_info[:2])
+del sys
+
+from .linalg import *  # noqa
+from .distance import *  # noqa

swmmanywhere-0.1.0/netcomp/distance/__init__.py

@@ -0,0 +1,10 @@
+"""*********
+Distances
+*********
+
+Calculation of distances between graphs.
+"""
+from __future__ import annotations
+
+from .exact import *
+from .features import *