Database creation and management software for SnowEx 2019/20 data. The goal is to create a single source (citeable) dataset that is cross queriable for snow researchers.

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.

• Database management for SnowEx Data
• Manage Site, Point, Profile and Raster Data
• Populate the snowex database
• Convenient GIS tools
• PostGreSQL Database end point for researchers

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

If you are are database maintainers or installing it for the first time follow the instructions below completely.

First ensure you have following prerequisites:

• Python3.5 +
• HomeBrew

Then to install the postgres database with postgis functionality run:

cd scripts/install && sh install_mac.sh

First ensure you have following prerequisites:

• Python3.5 +
• wget

Then to install the postgres database with postgis functionality run:

cd scripts/install && sh install_ubuntu.sh

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

Quickly test your installation by running:

pytest

This will run a series of tests that create a small database and confirm that samples of the data sets in the SnowEx2020_SQLdata folder can be uploaded seamlessly. These tests can serve as a nice way to see how to interact with the database but also serve to confirm our reproduciblity.

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

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
• Info on populating the database
• And more!

To see the documentation in your browser:

Warning: To see the examples/gallery you will need to populate the database before running this command. Otherwise they will be left with the last image submitted to GitHub.

make docs