Skip to main content

Python tools for obtaining and working with ICESat-2 data

Project description

Python tools for obtaining and working with ICESat-2 data

Documentation Status GitHub license Travis CI Status Code Coverage Conda install Pypi install

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 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 these tools 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. This project combines and generalizes these scripts into a unified framework, making them accessible for everyone.

Installation

The simplest way to install icepyx is by using the conda package manager. Conda install

conda install icepyx

Alternatively, you can also install icepyx using pip. Pypi install

pip install icepyx

More detailed instructions for installing icepyx can be found at https://icepyx.readthedocs.io/en/latest/getting_started/install.html

Examples (Jupyter Notebooks)

Listed below are example jupyter-notebooks

ICESat-2_DAAC_DataAccess_Example

ICESat-2_DAAC_DataAccess2_Subsetting

ICESat-2_DEM_comparison_Colombia_working

ICESat-2 Data Visualization Example

Citing icepyx

This community and software is developed with the goal of supporting science applications. Thus, our contributors (including those who have developed the packages used within icepyx) and maintainers justify their efforts and demonstrate the impact of their work through citations. Please see CITATION.rst for additional citation information.

Contact

Working with ICESat-2 data and have ideas you want to share? Have a great suggestion or recommendation of something you’d like to see implemented and want to find out if others would like that tool too? Come join the conversation at: https://discourse.pangeo.io/. Search for “icesat-2” under the “science” topic to find us.

Contribute

We welcome and invite contributions to icepyx from anyone at any career stage and with any amount of coding experience! Check out our contribution guidelines to see how you can contribute.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Contributor Covenant

Research notice

Please note that this repository is participating in a study into sustainability of open source projects. Data will be gathered about this repository for approximately the next 12 months, starting from June 2021.

Data collected will include number of contributors, number of PRs, time taken to close/merge these PRs, and issues closed.

For more information, please visit the informational page or download the participant information sheet.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

icepyx-0.4.1.tar.gz (49.4 kB view hashes)

Uploaded Source

Built Distribution

icepyx-0.4.1-py3-none-any.whl (46.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page