Welcome to snowexsql

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

Setup

Installing

Install using pip:

pip install snowexsql

Configuring the database connection

Using this library requires setting up the database connection credentials. There are two options to do this:

• Set database connection URL via SNOWEX_DB_CONNECTION environment variable Example:

export SNOWEX_DB_CONNECTION="user:[email protected]/db_name"

• Point to a credentials JSON file via SNOWEX_DB_CREDENTIALS environment variable Example

export SNOWEX_DB_CREDENTIALS="/path/to/credentials.json"

Sample JSON file:

{
  "address": "localhost",
  "db_name": "snowexdb",
  "username": "user",
  "password": "password"
}

Accessing the SnowEx data

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())

Getting help

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

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

I want to contribute

Thank you for the interest!

Our community follows the

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

Testing

To run the test suite locally requires having a running instance of PostgreSQL. The test suite is configured to run against these credentials:

builder:db_builder@localhost/test

This requires a running database on localhost where the user builder has access to the test database with the password db_builder.

It is possible to set a custom host and database via the SNOWEX_TEST_DB environment variable. Example that would connect to a server on my.host and the database snowex_test:

export SNOWEX_TEST_DB="my_host/snowex_test"

More on connection strings to PostgreSQL can be found with the official documentation.

DOI

• SnowEx Hackweek 2022 -
• SnowEx Hackweek 2024 -