====================
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
About
-----
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.
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 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())
I need help
------------
Jump over to `our discussion forum <https://github.com/SnowEx/snowexsql/discussions>`_
and get help from our community.
I want to contribute
---------------------
Thank you for the interest!
Our community follows the |Contributor Covenant|
.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
:target: code_of_conduct.md
.. _contribution guide: https://snowexsql.readthedocs.io/en/latest/community/contributing.html
Have a look at our `contribution guide`_ and see the many ways to get involved!
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
DOI
---
.. |HW22| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7618102.svg
:target: https://doi.org/10.5281/zenodo.7618102
* SnowEx Hackweek 2022 - |HW22|
=======
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/05/39/67f1ff43bff15474ae9d344a422136d2d897cf966a8cd2b33deb91e020dd/snowexsql-0.5.0.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\nAbout\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\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 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\nI need help\n------------\nJump over to `our discussion forum <https://github.com/SnowEx/snowexsql/discussions>`_ \nand get help from our community.\n\n\nI want to contribute\n---------------------\nThank you for the interest!\n\nOur community follows the |Contributor Covenant|\n\n.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg\n :target: code_of_conduct.md\n.. _contribution guide: https://snowexsql.readthedocs.io/en/latest/community/contributing.html\n\nHave a look at our `contribution guide`_ and see the many ways to get involved!\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\nDOI\n---\n.. |HW22| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7618102.svg \n :target: https://doi.org/10.5281/zenodo.7618102\n\n* SnowEx Hackweek 2022 - |HW22|\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.5.0",
"project_urls": {
"Homepage": "https://github.com/SnowEx/snowexsql"
},
"split_keywords": [
"snowexsql"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b97f3e3adc3643b79c1ca9e3df3241d3f2bd51d20a45d200dca16480f795ff99",
"md5": "471030687c7a8cfdf89f9698ddaa1ed6",
"sha256": "0453401df81b0b096c06a29bc6d399a9160e1773be35e5146db8e97458e21ced"
},
"downloads": -1,
"filename": "snowexsql-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "471030687c7a8cfdf89f9698ddaa1ed6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 24531,
"upload_time": "2024-08-13T16:02:23",
"upload_time_iso_8601": "2024-08-13T16:02:23.710486Z",
"url": "https://files.pythonhosted.org/packages/b9/7f/3e3adc3643b79c1ca9e3df3241d3f2bd51d20a45d200dca16480f795ff99/snowexsql-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "053967f1ff43bff15474ae9d344a422136d2d897cf966a8cd2b33deb91e020dd",
"md5": "668befaaed7dda5da28f03fe11912e00",
"sha256": "f94948aab57ed1488049f5d947c3d1f7bc4b998c7ec083d2c4d62278971e5e0b"
},
"downloads": -1,
"filename": "snowexsql-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "668befaaed7dda5da28f03fe11912e00",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4368816,
"upload_time": "2024-08-13T16:02:25",
"upload_time_iso_8601": "2024-08-13T16:02:25.005174Z",
"url": "https://files.pythonhosted.org/packages/05/39/67f1ff43bff15474ae9d344a422136d2d897cf966a8cd2b33deb91e020dd/snowexsql-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-13 16:02:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SnowEx",
"github_project": "snowexsql",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "snowexsql"
}
JSON
