=========
metevents
=========
.. image:: https://img.shields.io/pypi/v/metevents.svg
:target: https://pypi.python.org/pypi/metevents
.. image:: https://github.com/M3Works/metevents/actions/workflows/testing.yml/badge.svg
:target: https://github.com/M3Works/metevents/actions/workflows/testing.yml
:alt: Testing Status
.. image:: https://readthedocs.org/projects/metevents/badge/?version=latest
:target: https://metevents.readthedocs.io/en/latest/?version=latest
:alt: Documentation Status
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 <https://m3works.io>`_ 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
-------
.. code-block:: bash
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)
.. code-block:: bash
python3 -m pip install --upgrade pip
python3 -m pip install -r requirements_dev
python3 -m pip install .
Testing
-------
.. code-block:: bash
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.
.. code-block:: bash
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.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
0.1.0 (TBD)
------------
* Creation of the project
Raw data
{
"_id": null,
"home_page": "https://github.com/M3Works/metevents",
"name": "metevents",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "metevents",
"author": "M3Works",
"author_email": "m3worksllc@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ca/e9/d8cfe8f919b498e033a4ce7dabba22c4f521aabfd9d07722df7025e82c9e/metevents-0.3.0.tar.gz",
"platform": null,
"description": "=========\nmetevents\n=========\n\n\n.. image:: https://img.shields.io/pypi/v/metevents.svg\n :target: https://pypi.python.org/pypi/metevents\n.. image:: https://github.com/M3Works/metevents/actions/workflows/testing.yml/badge.svg\n :target: https://github.com/M3Works/metevents/actions/workflows/testing.yml\n :alt: Testing Status\n.. image:: https://readthedocs.org/projects/metevents/badge/?version=latest\n :target: https://metevents.readthedocs.io/en/latest/?version=latest\n :alt: Documentation Status\n\n\nMeteorlogical Events\n\nmetevents is a python library created with the goal of consistent, simple identification of\nmeteorology timeseries data. metevents is developed by `M3 Works <https://m3works.io>`_ as a tool\nfor performing analysis for hydrology models and station data. Contributions welcome!\n\nWarning - This software is provided as is (see the license), so use at your own risk.\nThis is an opensource package with the goal of making data wrangling easier. We make\nno guarantees about the quality or accuracy of the data and any interpretation of the meaning\nof the data is up to you.\n\n\n* Free software: BSD license\n\n\nFeatures\n--------\n\n\nRequirements\n------------\npython >= 3.7\n\nInstall\n-------\n.. code-block:: bash\n\n python3 -m pip install metevents\n\n\nLocal install for dev\n---------------------\nThe recommendation is to use virtualenv, but other local python\nenvironment isolation tools will work (pipenv, conda)\n\n.. code-block:: bash\n\n python3 -m pip install --upgrade pip\n python3 -m pip install -r requirements_dev\n python3 -m pip install .\n\nTesting\n-------\n\n.. code-block:: bash\n\n pytest\n\nIf contributing to the codebase, code coverage should not decrease\nfrom the contributions. Make sure to check code coverage before\nopening a pull request.\n\n.. code-block:: bash\n\n pytest --cov=metevents\n\nDocumentation\n-------------\nreadthedocs coming soon\n\nhttps://metevents.readthedocs.io.\n\nUsage\n-----\nSee usage documentation https://metevents.readthedocs.io/en/latest/usage.html\n\n\nUsage Examples\n==============\n\n\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\n0.1.0 (TBD)\n------------\n* Creation of the project\n\n",
"bugtrack_url": null,
"license": "BSD license",
"summary": "Timeseries Analysis for Meteorlogical Events (metevents)",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/M3Works/metevents"
},
"split_keywords": [
"metevents"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cae9d8cfe8f919b498e033a4ce7dabba22c4f521aabfd9d07722df7025e82c9e",
"md5": "086838187e4784d993c7a1c71f1f0cc3",
"sha256": "b0bc6d66e34abca59f91f84b6be062d11e8b3c61e8936c36e129a70755e57e87"
},
"downloads": -1,
"filename": "metevents-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "086838187e4784d993c7a1c71f1f0cc3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14980,
"upload_time": "2023-11-28T15:32:00",
"upload_time_iso_8601": "2023-11-28T15:32:00.307680Z",
"url": "https://files.pythonhosted.org/packages/ca/e9/d8cfe8f919b498e033a4ce7dabba22c4f521aabfd9d07722df7025e82c9e/metevents-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-28 15:32:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "M3Works",
"github_project": "metevents",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "metevents"
}
JSON
