Merge branch 'master' of github.com:csiro-hydroinformatics/hydrodiy

Author: jlerat

.github/workflows/python-package-conda.yml

@@ -38,7 +38,7 @@ jobs:
           pip install -e .
         
           # Run test
-          pytest --cov=hydrodiy --cov-config=.coveragerc hydrodiy
+          pytest --cov=hydrodiy --cov-config=.coveragerc --junitxml=junit/test-results.xml --cov-report=xml --cov-report=html hydrodiy
         
           # Run examples
           python examples/run_all_examples.py

README.md

@@ -0,0 +1,36 @@
+# hydrodiy
+[![CI](https://github.com/csiro-hydroinformatics/hydrodiy/actions/workflows/python-package-conda.yml/badge.svg)](https://github.com/csiro-hydroinformatics/hydrodiy/actions/workflows/python-package-conda.yml)
+
+Python toolbox for hydrological data processing.
+
+# What is hydrodiy?
+- hydrodiy is a set of tools to perform standard data analysis
+- the package is structured around typical tasks: io, data checking,
+  statistical analysis, gis processing and plotting
+
+# Installation
+- Create a suitable python environment. We recommend using [miniconda](https://docs.conda.io/projects/miniconda/en/latest/) combined with the environment specification provided in the [env_mini.yml] (env_mini.yml) file in this repository.
+- Git clone this repository and run `pip install .`
+
+# Basic use
+```python
+import numpy as np
+import matplotlib.pyplot as plt
+from hydrodiy.plot import violinplot
+
+data = np.random.normal(size=(200, 5))
+plt.close('all')
+fig, ax = plt.subplots(layout='tight')
+
+# Draw a nice violin plot
+vl = violinplot.Violin(data)
+vl.draw(ax=ax)
+
+plt.show()
+```
+A set of examples is provided in the folder [examples](examples).
+
+# License
+The source code and documentation of the hydrodiy package is licensed under the
+[BSD license](LICENSE.txt).
+