Skip to main content

metloom

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

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

# Find your data with ease
# !pip install folium mapclassify matplotlib
from metloom.pointdata import SnotelPointData, CDECPointData, USGSPointData
import geopandas as gpd
import pandas as pd

# Shapefile for the US states
shp = gpd.read_file('https://eric.clst.org/assets/wiki/uploads/Stuff/gz_2010_us_040_00_500k.json').to_crs("EPSG:4326")
# Filter to states of interest
west_states = ["Washington", "Oregon", "California", "Idaho", "Nevada", "Utah", "Wyoming", "Montana", "Colorado" ]  # , "Arizona", "New Mexico"]
shp = shp.loc[shp["NAME"].isin(west_states)].dissolve()

# Collect all points with SWE from CDEC and NRCS
dfs = []
for src in  [CDECPointData, SnotelPointData]:
    dfs.append(src.points_from_geometry(shp, [src.ALLOWED_VARIABLES.SWE]).to_dataframe())
# Combine dataframes
gdf = pd.concat(dfs)
# plot the shapefile
m = shp.explore(
    tooltip=False, color="grey", highlight=False, style_kwds={"opacity": 0.2}, popup=["NAME"]
)
# plot the points on top of the shapefile
gdf.explore(m=m, tooltip=["name", "id", "datasource"], color="red", marker_kwds={"radius":4})
Resulting plot of SWE trace at Banner summit

Features

# !pip install plotly
from metloom.pointdata import SnotelPointData
import plotly.express as px
import pandas as pd

# Initialize your point
pt = SnotelPointData("312:ID:SNTL", "Banner Summit")
swe_variable = pt.ALLOWED_VARIABLES.SWE
# Get the data
df = pt.get_daily_data(
    pd.to_datetime("2024-10-01"), pd.to_datetime("2025-03-11"), [swe_variable]
).reset_index()
# Create a time series plot using Plotly Express
px.line(df, x="datetime", y=swe_variable.name, title=f"{pt.name} SWE")
Resulting plot of SWE trace at Banner summit

Requirements

python >= 3.10

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.10.2

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.10.2
File Size Uploaded Provenance Actions
metloom-0.10.2.tar.gz 2.2 MB Without provenance Details for metloom-0.10.2.tar.gz

Built distribution (wheel)

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

Total release size: 2.3 MB

Release files / metloom-0.10.2.tar.gz

Download URL metloom-0.10.2.tar.gz
Size 2.2 MB
Tags Source
SHA-256 checksum
How to use checksums
91c2158c5140d38524ed695b53066ef4df4c0631c7bdb052a42cb97f96c5a4a1
BLAKE2b-256 checksum
How to use checksums
7c2619d4e782a2fb81fea8bb286384bd8fe1adeecaeabbdc4c537100dd933e3e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

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

Download URL metloom-0.10.2-py2.py3-none-any.whl
Size 65.7 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
2ed367eeb62dc10dc9a5c19f9bf63a44cc832ce041b395f8d37bdea715d6288d
BLAKE2b-256 checksum
How to use checksums
845d6f4b63012cf0691d6c9fdf01e0a11fc908caa147a1881b8eb43f9369432d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for metloom 0.10.2

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.10.2 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