metloom
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 across the Western US. metloom 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
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
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
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)
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)
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.3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| metloom-0.3.2.tar.gz | 49.9 kB | Without provenance | Details for metloom-0.3.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| metloom-0.3.2-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for metloom-0.3.2-py2.py3-none-any.whl |
Total release size: 82.0 kB
Release files / metloom-0.3.2.tar.gz
| Download URL | metloom-0.3.2.tar.gz |
|---|---|
| Size | 49.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
646c382425dce95b551ee33f5d5cb8b9c96aea0882a04738b3af547b3f4b8ca2
|
|
BLAKE2b-256 checksum How to use checksums |
27982bc6feaba83a8142a4fb59e98d9d535a5deb7dd9c73de32c4b424eb18027
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / metloom-0.3.2-py2.py3-none-any.whl
| Download URL | metloom-0.3.2-py2.py3-none-any.whl |
|---|---|
| Size | 32.1 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
f377a41723f8b166cc0c26b8913b88d37019cea0588a5badb7400a91cb79e92b
|
|
BLAKE2b-256 checksum How to use checksums |
349ba53612d320fb2f80c6c4e104d7224e28ab9a840e809f5142fe4f61d99dfa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Security for metloom 0.3.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.