UGentBiomath / wwdata

Python package to analyse, validate, fill and visualise data acquired in the context of (waste) water treatment
GNU General Public License v3.0
13 stars 12 forks source link
data-analysis jupyter-notebook

====== wwdata

.. image:: https://badge.fury.io/py/wwdata.svg :target: https://badge.fury.io/py/wwdata

.. image:: https://travis-ci.org/UGentBiomath/wwdata.svg?branch=master :target: https://travis-ci.org/UGentBiomath/wwdata

.. image:: https://readthedocs.org/projects/wwdata-docs/badge/ :target: https://wwdata-docs.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. image:: https://pyup.io/repos/github/UGentBiomath/wwdata/shield.svg :target: https://pyup.io/repos/github/UGentBiomath/wwdata/ :alt: Updates

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1288581.svg :target: https://doi.org/10.5281/zenodo.1288581

Data analysis package aimed at data obtained in the context of (waste)water

Structure

The package contains one class and three subclasses, all in separate .py files. Division in subclasses is based on the type of data:

Jupyter notbeook files (.ipynb) illustrate the use of the available functions. The most developed class is the OnlineSensorBased one. The workflow of this class is shown in below Figure, where OSB represents an OnlineSensorBased object. Main premises are to never delete data but to tag it and to be able to check the reliability when gaps in datasets are filled.

.. image:: ./figs/packagestructure_rel.png :align: center

Examples

For the workflow with code and more specific examples, check out the Showcase Jupyter Notebook(s) included as documentation of the package.

Credits

This package was created with support from Cookiecutter and the audreyr/cookiecutter-pypackage project template, as well as this GitHub page, provided by Daler and explaining how to use sphinx documentation generation in combination with GitHub Pages.

.. Cookiecutter: https://github.com/audreyr/cookiecutter .. audreyr/cookiecutter-pypackage: https://github.com/audreyr/cookiecutter-pypackage .. GitHub page: http://daler.github.io/sphinxdoc-test/includeme.html .. Daler: https://github.com/daler