====================
Welcome to snowexsql
====================
.. image:: https://readthedocs.org/projects/snowexsql/badge/?version=latest
:target: https://snowexsql.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/github/workflow/status/SnowEx/snowexsql/snowexsql
:target: https://github.com/SnowEx/snowexsql/actions/workflows/main.yml
:alt: Testing Status
.. image:: https://img.shields.io/pypi/v/snowexsql.svg
:target: https://pypi.org/project/snowexsql/
:alt: Code Coverage
.. image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/micahjohnson150/2034019acc40a963bd02d2fcbb31c5a9/raw/snowexsql__heads_master.json
:alt: Code Coverage
Database access and tools for using the `SnowEx database`_. This tool is
simply a client for accessing the database using python
.. _SnowEx database: https://www.github.com/SnowEx/snowex_db
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
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7618102.svg
:target: https://doi.org/10.5281/zenodo.7618102
Features
--------
* Database access for SnowEx Database
* Analysis tools
* Useful conversions to pandas and geopandas
* Lots of examples_
.. _examples: https://snowexsql.readthedocs.io/en/latest/examples.html
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:
.. code-block::
pip install snowexsql
I want to contribute!
---------------------
Install the python package by:
.. code-block:: bash
python3 setup.py install
If you are planning on running the tests or building the docs below also run:
.. code-block:: bash
pip install -r requirements_dev.txt
If you are using `conda` you may need to reinstall the following using conda:
* Jupyter notebook
* nbconvert
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.
.. _api: https://snowexsql.readthedocs.io/en/latest/api.html
.. code-block:: python
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())
Tests
-----
Before testing, in a seperate terminal, we need to run a local instance
of the database. This can be done with
.. code-block:: bash
docker-compose up -d
When you are finished testing, make sure to turn the docker off
.. code-block:: bash
docker-compose down
Quickly test your installation by running:
.. code-block:: bash
python3 -m pytest tests/
The goal of this project is to have high fidelity in data
interpretation/submission to the database. To see the current
test coverage run:
.. code-block:: bash
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.
.. code-block:: bash
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.
.. _snowex_db: https://github.com/SnowEx/snowex_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
Raw data
{
"_id": null,
"home_page": "https://github.com/SnowEx/snowexsql",
"name": "snowexsql",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "snowexsql",
"author": "Micah Johnson",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/17/17/49a7774848f4a36e85b6a516536085611787f6aa625e8aa0ac672b139c93/snowexsql-0.4.1.tar.gz",
"platform": null,
"description": "====================\nWelcome to snowexsql\n====================\n\n.. image:: https://readthedocs.org/projects/snowexsql/badge/?version=latest\n :target: https://snowexsql.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/github/workflow/status/SnowEx/snowexsql/snowexsql\n :target: https://github.com/SnowEx/snowexsql/actions/workflows/main.yml\n :alt: Testing Status\n\n.. image:: https://img.shields.io/pypi/v/snowexsql.svg\n :target: https://pypi.org/project/snowexsql/\n :alt: Code Coverage\n\n.. image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/micahjohnson150/2034019acc40a963bd02d2fcbb31c5a9/raw/snowexsql__heads_master.json\n :alt: Code Coverage\n\nDatabase access and tools for using the `SnowEx database`_. This tool is\nsimply a client for accessing the database using python\n\n.. _SnowEx database: https://www.github.com/SnowEx/snowex_db\n\nWARNING - 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. \n\nDOI\n---\n* SnowEx Hackweek 2022\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7618102.svg\n :target: https://doi.org/10.5281/zenodo.7618102\n\nFeatures\n--------\n\n* Database access for SnowEx Database\n* Analysis tools\n* Useful conversions to pandas and geopandas\n* Lots of examples_\n\n.. _examples: https://snowexsql.readthedocs.io/en/latest/examples.html\n\n\nInstalling\n----------\nIf you are just planning on using the database, then only install the\npython package instructions below.\n\nI just want to use it\n---------------------\nInstall using pip:\n\n.. code-block::\n\n pip install snowexsql\n\nI want to contribute!\n---------------------\nInstall the python package by:\n\n.. code-block:: bash\n\n python3 setup.py install\n\nIf you are planning on running the tests or building the docs below also run:\n\n.. code-block:: bash\n\n pip install -r requirements_dev.txt\n\nIf you are using `conda` you may need to reinstall the following using conda:\n\n * Jupyter notebook\n * nbconvert\n\n\nI want data fast!\n-----------------\nA programmatic API has been created for fast and standard\naccess to Point and Layer data. There are two examples_ covering the\nfeatures and usage of the api. See the specific api_ documentation for\ndetailed description.\n\n.. _api: https://snowexsql.readthedocs.io/en/latest/api.html\n\n.. code-block:: python\n\n from snowexsql.api import PointMeasurements, LayerMeasurements\n # The main functions we will use are `from_area` and `from_filter` like this\n df = PointMeasurements.from_filter(\n date=date(2020, 5, 28), instrument='camera'\n )\n print(df.head())\n\nTests\n-----\n\nBefore testing, in a seperate terminal, we need to run a local instance\nof the database. This can be done with\n\n.. code-block:: bash\n\n docker-compose up -d\n\nWhen you are finished testing, make sure to turn the docker off\n\n.. code-block:: bash\n\n docker-compose down\n\n\nQuickly test your installation by running:\n\n.. code-block:: bash\n\n python3 -m pytest tests/\n\nThe goal of this project is to have high fidelity in data\ninterpretation/submission to the database. To see the current\ntest coverage run:\n\n.. code-block:: bash\n\n make coverage\n\n\nDocumentation\n-------------\n\nThere is a whole host of resources for users in the documentation. It has been\nsetup for you to preview in your browser.\n\nIn there you will find:\n\n* Examples of database use\n* Database structure\n* API to the python package snowexsql\n* Links to other resources\n* Notes about the data uploaded\n* And more!\n\nTo see the documentation in your browser:\n\n**Warning**: To see the examples/gallery, the snowex db needs to be up. Otherwise they will be left with the\nlast image submitted to GitHub.\n\n.. code-block:: bash\n\n make docs\n\n\n=======\nHistory\n=======\n\n0.1.0 (2020-06-12)\n------------------\n\n* Project Created.\n\nHack Week 2021 (2021-07-15)\n---------------------------\n\n* Fully deployed database with around 100 users\n* Uploaded with fully reproducible DB using Snowex Data for Grand Mesa 2020\n* Timezones all in Mountain Standard\n\n0.2.0 Repo Split (2022-06-20)\n-----------------------------\n\n* Repo was split into an access client and a db builder to reduce overhead\n* snowexsql is now an access client and python tools to make life easy\n* snowex_db_ is now a repo containing all necessary assets to build db.\n\n.. _snowex_db: https://github.com/SnowEx/snowex_db\n\n0.3.0 (2022-07-6)\n-----------------------------\n\n* New columns were added to the LayerData table for flags\n* Converted surveyors to observers\n* Changed utm zone to be an integer\n",
"bugtrack_url": null,
"license": null,
"summary": "SQL Database software for SnowEx data",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://github.com/SnowEx/snowexsql"
},
"split_keywords": [
"snowexsql"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a069339e50c39471de49d9a8f5fac722e6ae8a64d41236640225d2faaffeaa99",
"md5": "4f18f5185f7bf17503b563c3d939eccd",
"sha256": "883703f318386c7068a1084ead1d3b7c9b55ee362e2633ff6478d6a42dc94539"
},
"downloads": -1,
"filename": "snowexsql-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f18f5185f7bf17503b563c3d939eccd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12766,
"upload_time": "2024-06-18T16:45:39",
"upload_time_iso_8601": "2024-06-18T16:45:39.638336Z",
"url": "https://files.pythonhosted.org/packages/a0/69/339e50c39471de49d9a8f5fac722e6ae8a64d41236640225d2faaffeaa99/snowexsql-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "171749a7774848f4a36e85b6a516536085611787f6aa625e8aa0ac672b139c93",
"md5": "f8c10922608ce3099ac01203c3eb5d82",
"sha256": "8caeeadbc2d21ec1ba7a00dbd7318e7fea104f9c32d605de5b61fbf3874ae021"
},
"downloads": -1,
"filename": "snowexsql-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "f8c10922608ce3099ac01203c3eb5d82",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3518648,
"upload_time": "2024-06-18T16:45:44",
"upload_time_iso_8601": "2024-06-18T16:45:44.628396Z",
"url": "https://files.pythonhosted.org/packages/17/17/49a7774848f4a36e85b6a516536085611787f6aa625e8aa0ac672b139c93/snowexsql-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-18 16:45:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SnowEx",
"github_project": "snowexsql",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "snowexsql"
}
JSON
