SnowEx / snowexsql

A project to access the database holding data from the NASA SnowEx campaign

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.

DOI

• SnowEx Hackweek 2022

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