Command line script and Python library to read Storm Water Management Model binary output.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for timcera from gravatar.com timcera

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (BSD-3-Clause)
  • Author: Tim Cera
  • Tags time-series, cli-app, swmm, stormwater, hydrograph, model, simulation, hydrology
  • Requires: Python >=3.8
Classifiers
Report project as malware

Project description

Tests Test Coverage Latest release BSD-3 clause license swmmtoolbox downloads PyPI - Python Version

swmmtoolbox - Overview

The swmmtoolbox is a Python script to read the Storm Water Management Model (SWMM) version 5 binary output files.

Requirements

Python - of course, version 3.7+.

Installation

The swmmtoolbox is available via pip or conda.

pip

pip install swmmtoolbox

conda

conda install -c conda-forge swmmtoolbox

Usage

Command Line

Just run ‘swmmtoolbox –help’ to get a list of subcommands and options:

usage: swmmtoolbox [-h]
                   {about,catalog,extract,listdetail,listvariables,stdtoswmm5}
                   ...

positional arguments:
  {about,catalog,extract,listdetail,listvariables,stdtoswmm5}
    about               Display version number and system information.
    catalog             List the catalog of objects in output file.
    extract             Get the time series data for a particular object and
                        variable.
    listdetail          List nodes and metadata in output file.
    listvariables       List variables available for each type.
    stdtoswmm5          Take the toolbox standard format and return SWMM5
                        format.

options:
  -h, --help            show this help message and exit

Python API

Simply import swmmtoolbox:

import swmmtoolbox

ntsd = swmmtoolbox.extract("tests/frutal.out", "node,45,Hydraulic_head")

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page