Welcome to Dotter’s documentation!

Contents

• Getting started with dotter
  • Installation
    • Install stable version
    • Install development version
  • Notebook tutorials

README

Dotter

This repository contains a set of eco-hydraulic tools to analyse (small) streams. It is aimed at (regional) water managers to aid in getting insight, decision making and visualisation.

The dottertools are distributed as a Python package.

UNDER DEVELOPMENT This package is currently under active development and has very little in the way of testing. You may well have problems running it. Use at your own risk.

Getting started

The easiest way to get started is to try out the interactive notebooks on binder.

You can also visit our documentation.

Installation

The current development branch of dotter can be installed from GitHub using pip:

pip install git+https://github.com/kdberends/dotter

Dependencies

Dotter is tested on Python 3.6 and depends on NumPy, SciPy, Pandas, and Matplotlib (see requirements.txt for version information).

Additionally, some notebooks make use of interactive widgets. To be able to correctly run the notebooks, you need to have ipywidgets installed and enabled; see here

To compile the sphinx documentation you need pandoc installed as well.

License

GPL License, Version 3.0

References

This project has been set up using PyScaffold 2.5.8. For details and usage information on PyScaffold see http://pyscaffold.readthedocs.org/.

Indices and tables

• Index
• Module Index
• Search Page