Metadata-Version: 2.1
Name: sammhelper
Version: 0.0.6
Summary: Supports mathematical modeling in the field of urban water management
Author-email: "Chairs of Urban Water Management (ETH Zurich)" <sww@ifu.baug.ethz.ch>
License: Copyright (c) 2018 The Python Packaging Authority
        
        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.
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

## What is it?
**sammhelper** is a Python package that supports mathematical modeling in the field of urban water management. It provides all functions required in the ETH Zurich lecture [Systems Analysis and Mathematical Modeling in Urban Water Management](https://sww.ifu.ethz.ch/education/lectures/systems-analysis.html).

## Main Features
**sammhelper** provides wrapper functions for:
- Ideal reactors modeling
- Sensitivity functions
- Parameter identification
- Error propagation
- Monte Carlo simulation
- PID controller

## Where to get it
The source code is currently hosted on ... (**TBD**).
The binary installer for the latest released version is available at the Python Package Index (PyPI):
```
pip install sammhelper
```

## Dependencies
- [Numpy](https://numpy.org/)
- [Scipy](https://scipy.org/)
- ...

## Documentation
The official documentation is hosted on ...

## Background
Work on **sammhelper** started at the [Chairs of Urban Water Management](https://sww.ifu.ethz.ch/) (ETH Zurich) in 2021 and has been under active development since then.

## Getting Help
<sww@ifu.baug.ethz.ch>