Skip to content

Commit

Permalink
add argo functionality to QUEST (#427)
Browse files Browse the repository at this point in the history
- add argo.py dataset functionality and implementation through QUEST
- demonstrate QUEST usage via example notebook
- add save to QUEST DataSet class template

Co-authored-by: Kelsey Bisson <48059682+kelseybisson@users.noreply.github.com>
Co-authored-by: Romina <romina.piunno@gmail.com>
Co-authored-by: zachghiaccio <zhfair@umich.edu>
  • Loading branch information
4 people authored Dec 7, 2023
1 parent d26422e commit 84f76ab
Show file tree
Hide file tree
Showing 10 changed files with 1,509 additions and 72 deletions.
16 changes: 10 additions & 6 deletions doc/source/contributing/quest-available-datasets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,21 @@ On this page, we outline the datasets that are supported by the QUEST module. Cl
List of Datasets
----------------

* `Argo <https://argo.ucsd.edu/data/>`_
* The Argo mission involves a series of floats that are designed to capture vertical ocean profiles of temperature, salinity, and pressure down to ~2000 m. Some floats are in support of BGC-Argo, which also includes data relevant for biogeochemical applications: oxygen, nitrate, chlorophyll, backscatter, and solar irradiance.
* (Link Kelsey's paper here)
* (Link to example workbook here)
`Argo <https://argo.ucsd.edu/data/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The Argo mission involves a series of floats that are designed to capture vertical ocean profiles of temperature, salinity, and pressure down to ~2000 m. Some floats are in support of BGC-Argo, which also includes data relevant for biogeochemical applications: oxygen, nitrate, chlorophyll, backscatter, and solar irradiance.

A paper outlining the Argo extension to QUEST is currently in preparation, with a citable preprint available in the near future.

:ref:`Argo Workflow Example<quest_workbook_label>`


Adding a Dataset to QUEST
-------------------------

Want to add a new dataset to QUEST? No problem! QUEST includes a template script (``dataset.py``) that may be used to create your own querying module for a dataset of interest.

Guidelines on how to construct your dataset module may be found here: (link to be added)
Once you have developed a script with the template, you may request for the module to be added to QUEST via GitHub.
Please see the How to Contribute page :ref:`dev_guide_label` for instructions on how to contribute to icepyx.

Once you have developed a script with the template, you may request for the module to be added to QUEST via Github. Please see the How to Contribute page :ref:`dev_guide_label` for instructions on how to contribute to icepyx.
Detailed guidelines on how to construct your dataset module are currently a work in progress.
Loading

0 comments on commit 84f76ab

Please sign in to comment.