Skip to main content

SQL Database software for SnowEx data

Project description

Documentation Status Testing Status Code Coverage https://codecov.io/gh/SnowEx/snowexsql/graph/badge.svg?token=B27OKGBOTR

About

Database access and tools for using the SnowEx database. This tool is simply a client for accessing the database using python

WARNING - This is under active development in preparation for SnowEx Hackweek. Use at your own risk. Data will change as it is QA/QC’d and the end goal is for all data in this database to be pulled from NSIDC. The goal is for this to become a community database open to all.

Features

  • Database access for SnowEx Database

  • Analysis tools

  • Useful conversions to pandas and geopandas

  • Lots of examples

Installing

If you are just planning on using the database, then only install the python package instructions below.

I just want to use it

Install using pip:

pip install snowexsql

I want data fast

A programmatic API has been created for fast and standard access to Point and Layer data. There are two examples covering the features and usage of the api. See the specific api documentation for detailed description.

from snowexsql.api import PointMeasurements, LayerMeasurements
# The main functions we will use are `from_area` and `from_filter` like this
df = PointMeasurements.from_filter(
    date=date(2020, 5, 28), instrument='camera'
)
print(df.head())

I need help

Jump over to our discussion forum and get help from our community.

I want to contribute

Thank you for the interest!

Our community follows the Contributor Covenant

Have a look at our contribution guide and see the many ways to get involved!

Documentation

There is a whole host of resources for users in the documentation. It has been setup for you to preview in your browser.

In there you will find:

  • Examples of database use

  • Database structure

  • API to the python package snowexsql

  • Links to other resources

  • Notes about the data uploaded

  • And more!

To see the documentation in your browser:

Warning: To see the examples/gallery, the snowex db needs to be up. Otherwise they will be left with the last image submitted to GitHub.

make docs

DOI

Project details


Download files

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

Source Distribution

snowexsql-0.6.0rc1.tar.gz (6.3 MB view details)

Uploaded Source

Built Distribution

snowexsql-0.6.0rc1-py3-none-any.whl (32.2 kB view details)

Uploaded Python 3

File details

Details for the file snowexsql-0.6.0rc1.tar.gz.

File metadata

  • Download URL: snowexsql-0.6.0rc1.tar.gz
  • Upload date:
  • Size: 6.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for snowexsql-0.6.0rc1.tar.gz
Algorithm Hash digest
SHA256 801335eb28a34d5efd79ca6d5f5d954824872ce914deb2f68f385f1f80eacacc
MD5 766ff37f08d8e119d085544ec5c808dd
BLAKE2b-256 9ed3c0971701ba8af9bacf574782a1839125030cabd4b1b379522532d0399e46

See more details on using hashes here.

Provenance

The following attestation bundles were made for snowexsql-0.6.0rc1.tar.gz:

Publisher: cd.yml on SnowEx/snowexsql

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

File details

Details for the file snowexsql-0.6.0rc1-py3-none-any.whl.

File metadata

  • Download URL: snowexsql-0.6.0rc1-py3-none-any.whl
  • Upload date:
  • Size: 32.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for snowexsql-0.6.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 ab74f8d5c011b18678ea3579192d8b94abf46eb666536e58854b7447a92e37c3
MD5 e04a21431a64069a48173e7e09468c23
BLAKE2b-256 3dd373e12f925d301ce03e9dfbae4de949c80617c8edf95c470b31a0eca82309

See more details on using hashes here.

Provenance

The following attestation bundles were made for snowexsql-0.6.0rc1-py3-none-any.whl:

Publisher: cd.yml on SnowEx/snowexsql

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page