Skip to content

Commit

Permalink
Added a brief mention to QUEST in icepyx docs intro. (#514)
Browse files Browse the repository at this point in the history
Co-authored-by: Jessica Scheick <[email protected]>
  • Loading branch information
zachghiaccio and JessicaS11 authored Apr 9, 2024
1 parent 5eb4501 commit e5fd7d1
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ Current development version (development branch): |Docs Status dev| |Travis dev

Origin and Purpose
------------------
icepyx is both a software library and a community composed of ICESat-2 data users, developers, and the scientific community. We are working together to develop a shared library of resources - including existing resources, new code, tutorials, and use-cases/examples - that simplify the process of querying, obtaining, analyzing, and manipulating ICESat-2 datasets to enable scientific discovery.
icepyx is both a software library and a community composed of ICESat-2 data users, developers, and the scientific community. We are working together to develop a shared library of resources - including existing resources, new code, tutorials, and use-cases/examples - that simplify the process of querying, obtaining, analyzing, and manipulating ICESat-2 and (via the QUEST module) relevant ancillary datasets to enable scientific discovery.

icepyx aims to provide a clearinghouse for code, functionality to improve interoperability, documentation, examples, and educational resources that tackle disciplinary research questions while minimizing the amount of repeated effort across groups utilizing similar datasets. icepyx also hopes to foster collaboration, open-science, and reproducible workflows by integrating and sharing resources.

Many of the underlying tools from which icepyx was developed began as Jupyter Notebooks developed for and during the cryosphere-themed ICESat-2 Hackweek at the University of Washington in June 2019 or as scripts written and used by the ICESat-2 Science Team members.
Originally called icesat2py, the project combined and generalized these scripts into a unified framework, adding examples, documentation, and testing where necessary and making them accessible for everyone.
Originally called icesat2py, the project combined and generalized these scripts into a unified framework, adding examples, documentation, and testing where necessary and making them accessible for everyone. Similar scripts were conceived at the 2021 Hackweek, which in turn led to the development of QUEST.
icepyx is now a domain-agnostic, standalone software package and community (under the broader `icesat2py GitHub organization <https://github.com/icesat2py>`_) that continues to build functionality for obtaining and working with ICESat-2 data products locally and in the cloud.
It also improves interoperability for ICESat-2 datasets with other open-source tools.

Expand Down Expand Up @@ -97,6 +97,8 @@ Listed below are example Jupyter notebooks for working with ICESat-2 (IS2).

`IS2_cloud_data_access <https://icepyx.readthedocs.io/en/latest/example_notebooks/IS2_cloud_data_access.html>`_

`QUEST_Finding_Argo_IS2_data <https://icepyx.readthedocs.io/en/latest/example_notebooks/QUEST_argo_data_access.html>`_


Citing icepyx
-------------
Expand Down
2 changes: 2 additions & 0 deletions doc/source/contributing/contribution_guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ Basic Steps to Contribute
We encourage users to follow the `git pull request workflow <https://www.asmeurer.com/git-workflow/>`_.
For more detailed steps, please see :ref:`How to Contribute<dev_guide_label>`.

For users that would like to add a dataset to the QUEST module, we are currently developing a Jupyter notebook to guide users through the necessary steps.

Licensing
^^^^^^^^^
icepyx is licensed under the `BSD-3 license <https://opensource.org/licenses/BSD-3-Clause>`_. Contributed code will also be licensed under BSD-3. If you did not write the code yourself, it is your responsibility to ensure that the existing license is compatible and included in the contributed files or you have documented permission from the original author to relicense the code.
Expand Down
10 changes: 10 additions & 0 deletions doc/source/contributing/quest-available-datasets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@ For interested readers, a preprint outlining the QUEST module and its applicatio

`Argo Workflow Example <https://icepyx.readthedocs.io/en/latest/example_notebooks/QUEST_argo_data_access.html>`_

QUEST uses the Argovis API to access Argo data, so users are encouraged to use the following citation:

.. container:: custom

Tucker, T., D. Giglio, M. Scanderbeg, and S.S.P. Shen, 2020.
Argovis: A Web Applications for Fast Delivery, Visualization, and Analysis of Argo data.
J. Atmos. Oceanic Technol., 37, 401-416, https://doi.org/10.1175/JTECH-D-19-0041.1

Citations for individual Argo datasets may be found at this link: https://argovis.colorado.edu/about


Adding a Dataset to QUEST
-------------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/source/getting_started/origin_purpose.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Origin and Purpose
==================

icepyx is both a software library and a community composed of ICESat-2 data users, developers, and the scientific community. We are working together to develop a shared library of resources - including existing resources, new code, tutorials, and use-cases/examples - that simplify the process of querying, obtaining, analyzing, and manipulating ICESat-2 and relevant ancillary datasets to enable scientific discovery.
icepyx is both a software library and a community composed of ICESat-2 data users, developers, and the scientific community. We are working together to develop a shared library of resources - including existing resources, new code, tutorials, and use-cases/examples - that simplify the process of querying, obtaining, analyzing, and manipulating ICESat-2 and (via the QUEST module) relevant ancillary datasets to enable scientific discovery.

icepyx aims to provide a clearinghouse for code, functionality to improve interoperability, documentation, examples, and educational resources that tackle disciplinary research questions while minimizing the amount of repeated effort across groups utilizing similar datasets. icepyx also hopes to foster collaboration, open-science, and reproducible workflows by integrating and sharing resources.

Expand Down
1 change: 1 addition & 0 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ We are working together to develop a shared library of resources -
including existing resources, new code, tutorials, and use-cases/examples -
that simplify the process of querying, obtaining, analyzing, and manipulating
ICESat-2 datasets to enable scientific discovery.
To further enhance data discovery, we have developed the QUEST module to facilitate querying of ICESat-2 data and complimentary Argo oceanographic data, with additional dataset support expected in the future.


.. panels::
Expand Down

0 comments on commit e5fd7d1

Please sign in to comment.