Giter VIP home page Giter VIP logo

metevents's Introduction

metevents

Testing Status 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 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.

metevents's People

Contributors

micah-prime avatar micahjohnson150 avatar

Stargazers

 avatar Charlie Parr avatar

metevents's Issues

Frequency could crash with an explanation

  • metevents version: 0.3.0
  • Python version: 3.9
  • Operating System: Mac OS

Description

StormEvents.find will crash if there is a fully missing timestep (not NAN). This should crash, but we should add an error describing why. Currently when determine_frequency is called, it returns None in this case.

We could change the default behavior of determine_frequency to raise a RunTimeError, but have a kwarg into the function to not raise an error if the user wants to get the None returned

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.