metevents

Meteorlogical Events

metevents is a python library created with the goal of consistent, simple identification of meteorology timeseries data. metevents is developed by M3 Works as a tool for performing analysis for hydrology models and station data. Contributions welcome!

Warning - This software is provided as is (see the license), so use at your own risk. This is an opensource package with the goal of making data wrangling easier. We make no guarantees about the quality or accuracy of the data and any interpretation of the meaning of the data is up to you.

• Free software: BSD license

Features

Requirements

python >= 3.7

Install

python3 -m pip install metevents

Local install for dev

The recommendation is to use virtualenv, but other local python environment isolation tools will work (pipenv, conda)

python3 -m pip install --upgrade pip
python3 -m pip install -r requirements_dev
python3 -m pip install .

Testing

pytest

If contributing to the codebase, code coverage should not decrease from the contributions. Make sure to check code coverage before opening a pull request.

pytest --cov=metevents

Documentation

readthedocs coming soon

https://metevents.readthedocs.io.

Usage

See usage documentation https://metevents.readthedocs.io/en/latest/usage.html

Usage Examples

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.