snowexsql 0.3.0

SQL Database software for SnowEx data

Welcome to snowexsql

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 to contribute!

Install the python package by:

python3 setup.py install

If you are planning on running the tests or building the docs below also run:

pip install -r requirements_dev.txt

If you are using conda you may need to reinstall the following using conda:

• Jupyter notebook

• nbconvert

Tests

Quickly test your installation by running:

pytest

The goal of this project is to have high fidelity in data interpretation/submission to the database. To see the current test coverage run:

make coverage

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

History

0.1.0 (2020-06-12)

• Project Created.

Hack Week 2021 (2021-07-15)

• Fully deployed database with around 100 users

• Uploaded with fully reproducible DB using Snowex Data for Grand Mesa 2020

• Timezones all in Mountain Standard

0.2.0 Repo Split (2022-06-20)

• Repo was split into an access client and a db builder to reduce overhead

• snowexsql is now an access client and python tools to make life easy

• snowex_db is now a repo containing all necessary assets to build db.

0.3.0 (2022-07-6)

• New columns were added to the LayerData table for flags

• Converted surveyors to observers

• Changed utm zone to be an integer