`snowtool`

Snow analysis tool for basin forecasting.

snowtool manages a snowdb — an on-disk directory holding multiple gridded snow datasets (SNODAS, UA SWANN, SPIRES/INSTARR, …) — and answers per-basin queries against it: zonal statistics of snow variables crossed over elevation bands, aspect classes, and forest-cover thresholds. It ships as a CLI and a read-only HTTP API, both sitting on the same core.

A snowdb is a plain directory: a root config, a pourpoints/ catalog, and a data/<dataset>/ tree of per-date COGs. Basins are delineated from pourpoints and burned into per-dataset area-weighted masks; queries reduce datasets over those masks live. Raster I/O is rasterio + async-tiff + griffine — no system GDAL required.

Installation

Requires Python 3.14+. Install as a uv tool:

uv tool install snowtool

Or run from a clone for development — see CONTRIBUTING.md.

Configuration

snowtool reads its snowdb location from the SNOWTOOL_SNOWDB_CONFIG environment variable (or the per-command --config/-C option). Dotenv loading is disabled, so the variable must be set in the environment:

export SNOWTOOL_SNOWDB_CONFIG=/path/to/snowdb/snowdb_conf.json

Usage

The CLI has top-level commands (init, status, doctor, stats) and command groups (dataset, pourpoint, api, windows); run snowtool --help or snowtool <command|group> --help for details. Serve the read-only HTTP API with uvicorn snowtool.api.app:get_app --factory (or snowtool api serve).

See the documentation for full usage, deployment (including Windows/IIS), and generated CLI, HTTP API, and Python API reference.

Contributing

See CONTRIBUTING.md for development setup, testing, and project conventions.

Team members: see the development notes for additional context.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snowtool-0.5.0.tar.gz (639.8 kB view details)

Uploaded Jul 25, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

snowtool-0.5.0-py3-none-any.whl (405.3 kB view details)

Uploaded Jul 25, 2026 Python 3

File details

Details for the file snowtool-0.5.0.tar.gz.

File metadata

Download URL: snowtool-0.5.0.tar.gz
Upload date: Jul 25, 2026
Size: 639.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for snowtool-0.5.0.tar.gz
Algorithm	Hash digest
SHA256	`b697b86ec7c1c902d541c9300c0ff2e8268781263f8562e75df834877c90f2d0`
MD5	`4b1b03263ca9718715b148db8cd1c6e6`
BLAKE2b-256	`dcfa0e0a24cda86a37bfdb9204af2c3e3fa3231c4eb137c5af740d148a11bfee`

See more details on using hashes here.

Provenance

The following attestation bundles were made for snowtool-0.5.0.tar.gz:

Publisher: release.yml on PSU-CSAR/snowtool

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: snowtool-0.5.0.tar.gz
- Subject digest: b697b86ec7c1c902d541c9300c0ff2e8268781263f8562e75df834877c90f2d0
- Sigstore transparency entry: 2242383752
- Sigstore integration time: Jul 25, 2026
Source repository:
- Permalink: PSU-CSAR/snowtool@b9ddbf969007c649b436cc9698231021645d1007
- Branch / Tag: refs/tags/v0.5.0
- Owner: https://github.com/PSU-CSAR
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@b9ddbf969007c649b436cc9698231021645d1007
- Trigger Event: release