{"id":13948394,"url":"https://github.com/icesat2py/icepyx","last_synced_at":"2025-05-15T05:07:04.305Z","repository":{"id":37898338,"uuid":"193000761","full_name":"icesat2py/icepyx","owner":"icesat2py","description":"Python tools for obtaining and working with ICESat-2 data","archived":false,"fork":false,"pushed_at":"2025-05-12T01:00:57.000Z","size":257994,"stargazers_count":233,"open_issues_count":100,"forks_count":111,"subscribers_count":14,"default_branch":"development","last_synced_at":"2025-05-13T21:43:57.727Z","etag":null,"topics":["closember","community-driven","hacktoberfest","icesat-2","python3"],"latest_commit_sha":null,"homepage":"https://icepyx.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/icesat2py.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"code_of_conduct.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-06-20T23:49:26.000Z","updated_at":"2025-05-09T16:35:22.000Z","dependencies_parsed_at":"2023-09-21T19:26:38.843Z","dependency_job_id":"71da45cd-fe52-4557-99fb-2c960f28c64c","html_url":"https://github.com/icesat2py/icepyx","commit_stats":{"total_commits":595,"total_committers":33,"mean_commits":18.03030303030303,"dds":0.3210084033613445,"last_synced_commit":"2511dc68c383d98065f6fad33cd2f1f7b77605de"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/icesat2py%2Ficepyx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/icesat2py%2Ficepyx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/icesat2py%2Ficepyx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/icesat2py%2Ficepyx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/icesat2py","download_url":"https://codeload.github.com/icesat2py/icepyx/tar.gz/refs/heads/development","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254069219,"owners_count":22009512,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["closember","community-driven","hacktoberfest","icesat-2","python3"],"created_at":"2024-08-08T05:01:22.075Z","updated_at":"2025-05-15T05:06:59.265Z","avatar_url":"https://github.com/icesat2py.png","language":"Python","funding_links":[],"categories":["LiDAR","Ice Sheets and Glaciers","Cryosphere"],"sub_categories":["EUMETlab","ISG Software","Glacier and Ice Sheets"],"readme":"icepyx\n======\n\n**Python tools for obtaining and working with ICESat-2 data**\n\n|Contributors| |GitHub license| |Conda install| |Pypi install|\n\n|JOSS| |Zenodo-all|\n\nLatest release (main branch): |Docs Status main| |Unit Tests Status (main)| |Integration Tests Status (main)| |Code Coverage main|\n\nCurrent development version (development branch): |Docs Status dev| |Unit Tests Status (dev)| |Integration Tests Status (main)| |Code Coverage dev| |Pre-commit dev|\n\n.. |GitHub license| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg\n   :target: https://opensource.org/licenses/BSD-3-Clause\n\n.. |Conda install| image:: https://anaconda.org/conda-forge/icepyx/badges/version.svg\n    :target: https://anaconda.org/conda-forge/icepyx\n\n.. |Pypi install| image:: https://badge.fury.io/py/icepyx.svg\n    :target: https://pypi.org/project/icepyx\n\n.. |Contributors| image:: https://img.shields.io/github/all-contributors/icesat2py/icepyx?color=ee8449\u0026style=flat-square(#contributors)\n    :alt: All Contributors\n    :target: https://github.com/icesat2py/icepyx/blob/main/CONTRIBUTORS.rst\n\n.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.04912/status.svg\n    :alt: JOSS publication link and DOI\n    :target: https://doi.org/10.21105/joss.04912\n\n.. |Zenodo-all| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7729175.svg\n    :alt: Zenodo all-versions DOI for icepyx\n    :target: https://doi.org/10.5281/zenodo.7729175\n\n.. |Docs Status main| image:: https://readthedocs.org/projects/icepyx/badge/?version=latest\n   :target: http://icepyx.readthedocs.io/?badge=latest\n\n.. |Docs Status dev| image:: https://readthedocs.org/projects/icepyx/badge/?version=development\n   :target: https://icepyx.readthedocs.io/en/development\n\n.. |Unit Tests Status (main)| image:: https://github.com/icesat2py/icepyx/actions/workflows/unit_test.yml/badge.svg?branch=main\n    :target: https://github.com/icesat2py/icepyx/actions/workflows/unit_test.yml\n\n.. |Integration Tests Status (main)| image:: https://github.com/icesat2py/icepyx/actions/workflows/integration_test.yml/badge.svg?branch=main\n    :target: https://github.com/icesat2py/icepyx/actions/workflows/integration_test.yml\n\n.. |Unit Tests Status (dev)| image:: https://github.com/icesat2py/icepyx/actions/workflows/unit_test.yml/badge.svg?branch=development\n    :target: https://github.com/icesat2py/icepyx/actions/workflows/unit_test.yml\n\n.. |Integration Tests Status (dev)| image:: https://github.com/icesat2py/icepyx/actions/workflows/integration_test.yml/badge.svg?branch=development\n    :target: https://github.com/icesat2py/icepyx/actions/workflows/integration_test.yml\n\n.. |Code Coverage main| image:: https://codecov.io/gh/icesat2py/icepyx/branch/main/graph/badge.svg\n    :target: https://codecov.io/gh/icesat2py/icepyx\n\n.. |Code Coverage dev| image:: https://codecov.io/gh/icesat2py/icepyx/branch/development/graph/badge.svg\n    :target: https://codecov.io/gh/icesat2py/icepyx\n\n.. |Pre-commit dev| image:: https://results.pre-commit.ci/badge/github/icesat2py/icepyx/development.svg\n   :target: https://results.pre-commit.ci/latest/github/icesat2py/icepyx/development\n   :alt: pre-commit.ci status\n\n\nOrigin and Purpose\n------------------\nicepyx 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.\n\nicepyx 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.\n\nMany 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.\nOriginally 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.\nicepyx is now a domain-agnostic, standalone software package and community (under the broader `icesat2py GitHub organization \u003chttps://github.com/icesat2py\u003e`_) that continues to build functionality for obtaining and working with ICESat-2 data products locally and in the cloud.\nIt also improves interoperability for ICESat-2 datasets with other open-source tools.\n\n.. _`zipped file`: https://github.com/icesat2py/icepyx/archive/main.zip\n.. _`Fiona`: https://pypi.org/project/Fiona/\n\nInstallation\n------------\n\nThe simplest way to install icepyx is by using the\n`conda \u003chttps://docs.conda.io/projects/conda/en/latest/user-guide/index.html\u003e`__\npackage manager. |Conda install|\n\n    conda install icepyx\n\nAlternatively, you can also install icepyx using `pip \u003chttps://pip.pypa.io/en/stable/\u003e`__. |Pypi install|\n\n    pip install icepyx\n\nMore detailed instructions for installing `icepyx` can be found at\nhttps://icepyx.readthedocs.io/en/latest/getting_started/install.html\n\nQuick Start\n-----------\n\n.. code-block:: python\n\n   import icepyx as ipx\n   query = ipx.Query(\n       # Collection short name\n       \"ATL06\",\n       # Bounding box\n       [-55, 68, -48, 71],\n       # Time bounds\n       ['2019-02-20','2019-02-28'],\n   )\n   query.download_granules('/tmp/icepyx')\n\n.. code-block:: bash\n\n   $ ls -1 /tmp/icepyx/\n   processed_ATL06_20190221121851_08410203_006_02.h5\n   processed_ATL06_20190222010344_08490205_006_02.h5\n   processed_ATL06_20190225121032_09020203_006_02.h5\n   processed_ATL06_20190226005526_09100205_006_02.h5\n\nSee the examples below for more things `icepyx` can do!\n\n\nExamples (Jupyter Notebooks)\n----------------------------\n\nListed below are example Jupyter notebooks for working with ICESat-2 (IS2).\n\n`IS2_data_access \u003chttps://icepyx.readthedocs.io/en/latest/example_notebooks/IS2_data_access.html\u003e`_\n\n`IS2_data_access2_subsetting \u003chttps://icepyx.readthedocs.io/en/latest/example_notebooks/IS2_data_access2-subsetting.html\u003e`_\n\n`IS2_data_variables \u003chttps://icepyx.readthedocs.io/en/latest/example_notebooks/IS2_data_variables.html\u003e`_\n\n`IS2_data_visualization \u003chttps://icepyx.readthedocs.io/en/latest/example_notebooks/IS2_data_visualization.html\u003e`_\n\n`IS2_data_read-in \u003chttps://icepyx.readthedocs.io/en/latest/example_notebooks/IS2_data_read-in.html\u003e`_\n\n`IS2_cloud_data_access \u003chttps://icepyx.readthedocs.io/en/latest/example_notebooks/IS2_cloud_data_access.html\u003e`_\n\n`QUEST_Finding_Argo_IS2_data \u003chttps://icepyx.readthedocs.io/en/latest/example_notebooks/QUEST_argo_data_access.html\u003e`_\n\n\nCiting icepyx\n-------------\n.. _`CITATION.rst`: ./CITATION.rst\n\nThis 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.\n\nContact\n-------\nWorking with ICESat-2 data and have ideas you want to share?\nHave a great suggestion or recommendation of something you'd like to see\nimplemented and want to find out if others would like that tool too?\nCome join the conversation at: https://discourse.pangeo.io/.\nSearch for \"icesat-2\" under the \"science\" topic to find us.\n\n.. _`icepyx`: https://github.com/icesat2py/icepyx\n.. _`contribution guidelines`: ./doc/source/contributing/contribution_guidelines.rst\n\nContribute\n----------\nWe welcome and invite contributions to icepyx_ from anyone at any career stage and with any amount of coding experience!\nCheck out our `contribution guidelines`_ to see how you can contribute.\n\nPlease 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|\n\n.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg\n   :target: code_of_conduct.md\n\nResearch notice\n~~~~~~~~~~~~~~~\n\nPlease note that this repository is participating in a study into\nsustainability of open source projects. Data will be gathered about this\nrepository for approximately the next 12 months, starting from June\n2021.\n\nData collected will include number of contributors, number of PRs, time\ntaken to close/merge these PRs, and issues closed.\n\nFor more information, please visit `the informational\npage \u003chttps://sustainable-open-science-and-software.github.io/\u003e`__ or\ndownload the `participant information\nsheet \u003chttps://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf\u003e`__.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficesat2py%2Ficepyx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ficesat2py%2Ficepyx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficesat2py%2Ficepyx/lists"}