Package: icepyx
Python tools for obtaining and working with ICESat-2 dataLatest release (main branch):Current development version (development branch):Origin and Purposeicepyx 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 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.
icepyx is now a domain-agnostic, standalone software package and community (under the broadericesat2py GitHub organization) 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.InstallationThe simplest way to install icepyx is by using thecondapackage manager.conda install icepyxAlternatively, you can also install icepyx usingpip.pip install icepyxMore detailed instructions for installingicepyxcan be found athttps://icepyx.readthedocs.io/en/latest/getting_started/install.htmlExamples (Jupyter Notebooks)Listed below are example Jupyter notebooks for working with ICESat-2 (IS2).IS2_data_accessIS2_data_access2_subsettingIS2_data_variablesIS2_data_visualizationIS2_data_read-inIS2_cloud_data_access (BETA ONLY)Citing icepyxThis 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 seeCITATION.rstfor additional citation information.ContactWorking 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.ContributeWe welcome and invite contributions toicepyxfrom anyone at any career stage and with any amount of coding experience!
Check out ourcontribution guidelinesto 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.Research noticePlease 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 visitthe informational
pageor
download theparticipant information
sheet.