Skip to main content

metloom

https://img.shields.io/pypi/v/metloom.svg Testing Status Documentation Status Code Coverage

Location Oriented Observed Meteorology

metloom is a python library created with the goal of consistent, simple sampling of meteorology and snow related point measurments from a variety of datasources is developed by M3 Works as a tool for validating computational hydrology model results. 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 metloom
  • Common install issues:
    • Macbook M1 and M2 chips: some python packages run into issues with the new M chips
      • error : from lxml import etree in utils.py ((mach-o file, but is an incompatible architecture (have 'x86_64', need 'arm64)

        The solution is the following

        pip uninstall lxml
        pip install --no-binary lxml lxml

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=metloom

Documentation

readthedocs coming soon

https://metloom.readthedocs.io.

Usage

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

NOTES: PointData methods that get point data return a GeoDataFrame indexed on both datetime and station code. To reset the index simply run df.reset_index(inplace=True)

Simple usage examples are provided in this readme and in the docs. See our examples for code walkthroughs and more complicated use cases.

Usage Examples

Use metloom to find data for a station

from datetime import datetime
from metloom.pointdata import SnotelPointData

snotel_point = SnotelPointData("713:CO:SNTL", "MyStation")
df = snotel_point.get_daily_data(
    datetime(2020, 1, 2), datetime(2020, 1, 20),
    [snotel_point.ALLOWED_VARIABLES.SWE]
)
print(df)

Use metloom to find snow courses within a geometry

from metloom.pointdata import CDECPointData
from metloom.variables import CdecStationVariables

import geopandas as gpd

fp = <path to shape file>
obj = gpd.read_file(fp)

vrs = [
    CdecStationVariables.SWE,
    CdecStationVariables.SNOWDEPTH
]
points = CDECPointData.points_from_geometry(obj, vrs, snow_courses=True)
df = points.to_dataframe()
print(df)

Tutorials

In the Examples folder, there are multiple Jupyter notbook based tutorials. You can edit and run these notebooks by running Jupyter Lab from the command line

pip install jupyterlab
jupyter lab

This will open a Jupyter Lab session in your default browser.

Credits

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

History

0.1.0 (2021-10-05)

  • This is the first release!

  • Create the package

  • Add CDEC functionality

  • Add SNOTEL functionality

  • Add CLI to find stations from shapefile

  • Write a custom Snotel client using zeep

0.2.0 (2021-12-29)

  • Added mesowest network

  • Added in a token json arg to the get_*_data functions

  • Pinned docutils for an update that happened

  • Added in a resample_df function for the highway stations where the returned data is 5min for air temp.

0.3.0 (2022-10-28)

  • Added USGS network

Metadata

Release files for metloom 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for metloom 0.6.0
File Size Uploaded Provenance Actions
metloom-0.6.0.tar.gz 454.4 kB Without provenance Details for metloom-0.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for metloom 0.6.0
File Interpreter ABI Platform Actions
metloom-0.6.0-py2.py3-none-any.whl Python 2, Python 3 none any Details for metloom-0.6.0-py2.py3-none-any.whl

Total release size: 511.1 kB

Release files / metloom-0.6.0.tar.gz

Download URL metloom-0.6.0.tar.gz
Size 454.4 kB
Tags Source
SHA-256 checksum
How to use checksums
a88e7d66409fb1c55a75f87fb66d11dd2e6a68cecc9eacc72fdd65241adbcb25
BLAKE2b-256 checksum
How to use checksums
2dd141d90bf362cf2179b0f1df305147dc7a58059790131a84a63c856109d328
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.19

Release files / metloom-0.6.0-py2.py3-none-any.whl

Download URL metloom-0.6.0-py2.py3-none-any.whl
Size 56.7 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
98302fdb21f020f819fe116f33d76be06b259a11ea9ab586100e3cea14538b3e
BLAKE2b-256 checksum
How to use checksums
8de6106902d7058ed3017055175c425ec08df7b18f8a86388579035c5ff9dcf4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.19

Security for metloom 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.6.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page