Skip to main content

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

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")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

swmmtoolbox-4.0.11.tar.gz (1.4 MB view hashes)

Uploaded source

Supported by

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