=============
read-ICESat-2
=============
|Language|
|License|
|PyPI Version|
|Documentation Status|
|zenodo|
|Shot Count|
.. |Language| image:: https://img.shields.io/pypi/pyversions/icesat2-toolkit?color=green
:target: https://www.python.org/
.. |License| image:: https://img.shields.io/badge/license-MIT-green.svg
:target: https://github.com/tsutterley/read-ICESat-2/blob/main/LICENSE
.. |PyPI Version| image:: https://img.shields.io/pypi/v/icesat2-toolkit.svg
:target: https://pypi.python.org/pypi/icesat2-toolkit/
.. |Documentation Status| image:: https://readthedocs.org/projects/read-icesat-2/badge/?version=latest
:target: https://read-icesat-2.readthedocs.io/en/latest/?badge=latest
.. |zenodo| image:: https://zenodo.org/badge/193143942.svg
:target: https://zenodo.org/badge/latestdoi/193143942
.. |Shot count| image:: https://img.shields.io/badge/dynamic/json?label=ICESat-2%20shot%20count&query=message&url=https%3A%2F%2Fraw.githubusercontent.com%2Ftsutterley%2Ftsutterley%2Fmaster%2FIS2-shot-count.json
:target: https://icesat-2.gsfc.nasa.gov/
Python tools for obtaining and working with elevation data from the NASA ICESat-2 mission
- https://icesat-2.gsfc.nasa.gov
- https://icesat-2-scf.gsfc.nasa.gov
- https://nsidc.org/data/icesat-2/
ICESat-2 Data Products
######################
+-----------+------------------------------+-------------------------------------------+
| Product | Name | Description |
+===========+==============================+===========================================+
| **ATL00** | Telemetry Data | Raw ATLAS telemetry in packet format |
+-----------+------------------------------+-------------------------------------------+
| **ATL01** | Reformatted Telemetry | Parsed, partially reformatted into HDF5, |
| | | generated daily, segmented into several |
| | | minute granules |
+-----------+------------------------------+-------------------------------------------+
| **ATL02** | Science Unit Converted | Photon time of flight, corrected for |
| | Telemetry | instrument effects. Includes all photons, |
| | | pointing data, spacecraft position, |
| | | housekeeping data, engineering data, and |
| | | raw atmospheric profiles, segmented into |
| | | several minute granules. |
+-----------+------------------------------+-------------------------------------------+
| **ATL03** | Global Geolocated Photon | Precise latitude, longitude and elevation |
| | Data | for every received photon, arranged by |
| | | beam in the along-track direction. |
| | | Photons classified by signal vs. |
| | | background, as well as by surface type |
| | | (land ice, sea ice, land, ocean), |
| | | including all geophysical corrections. |
| | | Segmented into several minute granules. |
+-----------+------------------------------+-------------------------------------------+
| **ATL04** | Uncalibrated Backscatter | Along-track atmospheric backscatter data, |
| | Profiles | 25 times per second. Includes calibration |
| | | coefficients for polar regions. Segmented |
| | | into several minute granules. |
+-----------+------------------------------+-------------------------------------------+
| **ATL06** | Land Ice Elevation | Surface height for each beam with along- |
| | | and across-track slopes calculated for |
| | | each beam pair. Posted at 40 meters |
| | | along-track. Segmented into several |
| | | minute granules. |
+-----------+------------------------------+-------------------------------------------+
| **ATL07** | Arctic/Antarctic Sea Ice | Height of sea ice and open water leads at |
| | Elevation | varying length scale based on returned |
| | | photon rate for each beam presented |
| | | along-track. Segmented into several |
| | | minute granules. |
+-----------+------------------------------+-------------------------------------------+
| **ATL08** | Land Water Vegetation | Height of ground including canopy surface |
| | Elevation | posted at variable length scales relative |
| | | to signal level, for each beam presented |
| | | along-track. Where data permits include |
| | | canopy height, canopy cover percentage, |
| | | surface slope and roughness, and apparent |
| | | reflectance. |
+-----------+------------------------------+-------------------------------------------+
| **ATL09** | Calibrated Backscatter and | Along-track cloud and other significant |
| | Cloud Characteristics | atmosphere layer heights, blowing snow, |
| | | integrated backscatter, and optical |
| | | depth. |
+-----------+------------------------------+-------------------------------------------+
| **ATL10** | Arctic/Antarctic Sea Ice | Estimate of sea ice freeboard over |
| | Freeboard | specific spatial scales using all |
| | | available sea surface height |
| | | measurements. Contains statistics of sea |
| | | surface and sea ice heights. |
+-----------+------------------------------+-------------------------------------------+
| **ATL11** | Antarctic/Greenland Ice | Time series of height at points on the |
| | Sheet H(t) Series | ice sheet, calculated based on repeat |
| | | tracks and/or cross-overs. |
+-----------+------------------------------+-------------------------------------------+
| **ATL12** | Ocean Elevation | Surface height at specific length scale. |
+-----------+------------------------------+-------------------------------------------+
| **ATL13** | Inland Water Height | Along-track inland and near shore water |
| | | surface height distribution within water |
| | | mask. |
+-----------+------------------------------+-------------------------------------------+
| **ATL14** | Antarctic/Greenland Ice | Height maps of each ice sheet for each |
| | Sheet H(t) Gridded | year based on all available elevation |
| | | data. |
+-----------+------------------------------+-------------------------------------------+
| **ATL15** | Antarctic/Greenland Ice | Height change maps for each ice sheet, |
| | Sheet dh/dt Gridded | for each mission year, and for the whole |
| | | mission. |
+-----------+------------------------------+-------------------------------------------+
| **ATL16** | ATLAS Atmosphere Weekly | Polar cloud fraction, blowing snow |
| | | frequency, ground detection frequency. |
+-----------+------------------------------+-------------------------------------------+
| **ATL17** | ATLAS Atmosphere Monthly | Polar cloud fraction, blowing snow |
| | | frequency, ground detection frequency. |
+-----------+------------------------------+-------------------------------------------+
| **ATL18** | Land/Canopy Gridded | Gridded ground surface height, canopy |
| | | height, and canopy cover estimates. |
+-----------+------------------------------+-------------------------------------------+
| **ATL19** | Mean Sea Surface (MSS) | Gridded ocean height product. |
+-----------+------------------------------+-------------------------------------------+
| **ATL20** | Arctic/Antarctic Gridded Sea | Gridded sea ice freeboard. |
| | Ice Freeboard | |
+-----------+------------------------------+-------------------------------------------+
| **ATL21** | Arctic/Antarctic Gridded Sea | Gridded monthly sea surface height inside |
| | Surface Height w/in Sea Ice | the sea ice cover. |
+-----------+------------------------------+-------------------------------------------+
ICESat-2 Granules
#################
Each orbit of ICESat-2 data is broken up into 14 granules.
The granule boundaries limit the size of each ATL03 file and simplify the formation of higher level data products.
.. image:: ./doc/source/_assets/ICESat-2_granules_global.png
:alt: ICESat-2 global granules
.. image:: ./doc/source/_assets/ICESat-2_granules_polar.png
:alt: ICESat-2 polar granules
Dependencies
############
- `numpy: Scientific Computing Tools For Python <https://numpy.org>`_
- `scipy: Scientific Tools for Python <https://docs.scipy.org/doc//>`_
- `mpi4py: Python bindings of the Message Passing Interface (MPI) <https://mpi4py.readthedocs.io/en/stable/>`_
- `h5py: Python interface for Hierarchal Data Format 5 (HDF5) <http://h5py.org>`_
- `netCDF4: Python interface to the netCDF C library <https://unidata.github.io/netcdf4-python/>`_
- `zarr: Chunked, compressed, N-dimensional arrays in Python <https://github.com/zarr-developers/zarr-python>`_
- `pandas: Python Data Analysis Library <https://pandas.pydata.org/>`_
- `scikit-learn: Machine Learning in Python <https://scikit-learn.org/stable/index.html>`_
- `dateutil: powerful extensions to datetime <https://dateutil.readthedocs.io/en/stable/>`_
- `shapely: PostGIS-ish operations outside a database context for Python <http://toblerity.org/shapely/index.html>`_
- `fiona: Python wrapper for vector data access functions from the OGR library <https://fiona.readthedocs.io/en/latest/manual.html>`_
- `future: Compatibility layer between Python 2 and Python 3 <http://python-future.org/>`_
- `boto3: Amazon Web Services (AWS) SDK for Python <https://boto3.amazonaws.com/v1/documentation/api/latest/index.html>`_
- `s3fs: Pythonic file interface to S3 built on top of botocore <https://s3fs.readthedocs.io/en/latest/>`_
- `lxml: processing XML and HTML in Python <https://pypi.python.org/pypi/lxml>`_
- `paramiko: Native Python SSHv2 protocol library <http://www.paramiko.org>`_
- `scp: scp module for paramiko <https://github.com/jbardin/scp.py>`_
- `yapc: Python version of the NASA Goddard Space Flight Center YAPC Program <https://github.com/tsutterley/yapc>`_
Download
########
| The program homepage is:
| https://github.com/tsutterley/read-icesat-2
| A zip archive of the latest version is available directly at:
| https://github.com/tsutterley/read-icesat-2/archive/main.zip
Disclaimer
##########
This project contains work and contributions from the `scientific community <./CONTRIBUTORS.rst>`_.
This program is not sponsored or maintained by the Universities Space Research Association (USRA) or NASA.
It is provided here for your convenience but *with no guarantees whatsoever*.
License
#######
The content of this project is licensed under the
`Creative Commons Attribution 4.0 Attribution license <https://creativecommons.org/licenses/by/4.0/>`_
and the source code is licensed under the `MIT license <LICENSE>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/tsutterley/read-ICESat-2",
"name": "icesat2-toolkit",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ICESat-2 laser altimetry,ATLAS,surface elevation and change",
"author": "Tyler Sutterley",
"author_email": "tsutterl@uw.edu",
"download_url": "https://files.pythonhosted.org/packages/18/2f/6f12714156f48294e87d4b4baa62d87c3c916ca377dcc28e58570c958a3a/icesat2-toolkit-1.3.1.tar.gz",
"platform": null,
"description": "=============\nread-ICESat-2\n=============\n\n|Language|\n|License|\n|PyPI Version|\n|Documentation Status|\n|zenodo|\n|Shot Count|\n\n.. |Language| image:: https://img.shields.io/pypi/pyversions/icesat2-toolkit?color=green\n :target: https://www.python.org/\n\n.. |License| image:: https://img.shields.io/badge/license-MIT-green.svg\n :target: https://github.com/tsutterley/read-ICESat-2/blob/main/LICENSE\n\n.. |PyPI Version| image:: https://img.shields.io/pypi/v/icesat2-toolkit.svg\n :target: https://pypi.python.org/pypi/icesat2-toolkit/\n\n.. |Documentation Status| image:: https://readthedocs.org/projects/read-icesat-2/badge/?version=latest\n :target: https://read-icesat-2.readthedocs.io/en/latest/?badge=latest\n\n.. |zenodo| image:: https://zenodo.org/badge/193143942.svg\n :target: https://zenodo.org/badge/latestdoi/193143942\n\n.. |Shot count| image:: https://img.shields.io/badge/dynamic/json?label=ICESat-2%20shot%20count&query=message&url=https%3A%2F%2Fraw.githubusercontent.com%2Ftsutterley%2Ftsutterley%2Fmaster%2FIS2-shot-count.json\n :target: https://icesat-2.gsfc.nasa.gov/\n\nPython tools for obtaining and working with elevation data from the NASA ICESat-2 mission\n\n- https://icesat-2.gsfc.nasa.gov\n- https://icesat-2-scf.gsfc.nasa.gov\n- https://nsidc.org/data/icesat-2/\n\nICESat-2 Data Products\n######################\n\n+-----------+------------------------------+-------------------------------------------+\n| Product | Name | Description |\n+===========+==============================+===========================================+\n| **ATL00** | Telemetry Data | Raw ATLAS telemetry in packet format |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL01** | Reformatted Telemetry | Parsed, partially reformatted into HDF5, |\n| | | generated daily, segmented into several |\n| | | minute granules |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL02** | Science Unit Converted | Photon time of flight, corrected for |\n| | Telemetry | instrument effects. Includes all photons, |\n| | | pointing data, spacecraft position, |\n| | | housekeeping data, engineering data, and |\n| | | raw atmospheric profiles, segmented into |\n| | | several minute granules. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL03** | Global Geolocated Photon | Precise latitude, longitude and elevation |\n| | Data | for every received photon, arranged by |\n| | | beam in the along-track direction. |\n| | | Photons classified by signal vs. |\n| | | background, as well as by surface type |\n| | | (land ice, sea ice, land, ocean), |\n| | | including all geophysical corrections. |\n| | | Segmented into several minute granules. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL04** | Uncalibrated Backscatter | Along-track atmospheric backscatter data, |\n| | Profiles | 25 times per second. Includes calibration |\n| | | coefficients for polar regions. Segmented |\n| | | into several minute granules. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL06** | Land Ice Elevation | Surface height for each beam with along- |\n| | | and across-track slopes calculated for |\n| | | each beam pair. Posted at 40 meters |\n| | | along-track. Segmented into several |\n| | | minute granules. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL07** | Arctic/Antarctic Sea Ice | Height of sea ice and open water leads at |\n| | Elevation | varying length scale based on returned |\n| | | photon rate for each beam presented |\n| | | along-track. Segmented into several |\n| | | minute granules. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL08** | Land Water Vegetation | Height of ground including canopy surface |\n| | Elevation | posted at variable length scales relative |\n| | | to signal level, for each beam presented |\n| | | along-track. Where data permits include |\n| | | canopy height, canopy cover percentage, |\n| | | surface slope and roughness, and apparent |\n| | | reflectance. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL09** | Calibrated Backscatter and | Along-track cloud and other significant |\n| | Cloud Characteristics | atmosphere layer heights, blowing snow, |\n| | | integrated backscatter, and optical |\n| | | depth. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL10** | Arctic/Antarctic Sea Ice | Estimate of sea ice freeboard over |\n| | Freeboard | specific spatial scales using all |\n| | | available sea surface height |\n| | | measurements. Contains statistics of sea |\n| | | surface and sea ice heights. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL11** | Antarctic/Greenland Ice | Time series of height at points on the |\n| | Sheet H(t) Series | ice sheet, calculated based on repeat |\n| | | tracks and/or cross-overs. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL12** | Ocean Elevation | Surface height at specific length scale. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL13** | Inland Water Height | Along-track inland and near shore water |\n| | | surface height distribution within water |\n| | | mask. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL14** | Antarctic/Greenland Ice | Height maps of each ice sheet for each |\n| | Sheet H(t) Gridded | year based on all available elevation |\n| | | data. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL15** | Antarctic/Greenland Ice | Height change maps for each ice sheet, |\n| | Sheet dh/dt Gridded | for each mission year, and for the whole |\n| | | mission. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL16** | ATLAS Atmosphere Weekly | Polar cloud fraction, blowing snow |\n| | | frequency, ground detection frequency. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL17** | ATLAS Atmosphere Monthly | Polar cloud fraction, blowing snow |\n| | | frequency, ground detection frequency. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL18** | Land/Canopy Gridded | Gridded ground surface height, canopy |\n| | | height, and canopy cover estimates. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL19** | Mean Sea Surface (MSS) | Gridded ocean height product. |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL20** | Arctic/Antarctic Gridded Sea | Gridded sea ice freeboard. |\n| | Ice Freeboard | |\n+-----------+------------------------------+-------------------------------------------+\n| **ATL21** | Arctic/Antarctic Gridded Sea | Gridded monthly sea surface height inside |\n| | Surface Height w/in Sea Ice | the sea ice cover. |\n+-----------+------------------------------+-------------------------------------------+\n\n\nICESat-2 Granules\n#################\n\nEach orbit of ICESat-2 data is broken up into 14 granules.\nThe granule boundaries limit the size of each ATL03 file and simplify the formation of higher level data products.\n\n.. image:: ./doc/source/_assets/ICESat-2_granules_global.png\n :alt: ICESat-2 global granules\n\n.. image:: ./doc/source/_assets/ICESat-2_granules_polar.png\n :alt: ICESat-2 polar granules\n\nDependencies\n############\n\n- `numpy: Scientific Computing Tools For Python <https://numpy.org>`_\n- `scipy: Scientific Tools for Python <https://docs.scipy.org/doc//>`_\n- `mpi4py: Python bindings of the Message Passing Interface (MPI) <https://mpi4py.readthedocs.io/en/stable/>`_\n- `h5py: Python interface for Hierarchal Data Format 5 (HDF5) <http://h5py.org>`_\n- `netCDF4: Python interface to the netCDF C library <https://unidata.github.io/netcdf4-python/>`_\n- `zarr: Chunked, compressed, N-dimensional arrays in Python <https://github.com/zarr-developers/zarr-python>`_\n- `pandas: Python Data Analysis Library <https://pandas.pydata.org/>`_\n- `scikit-learn: Machine Learning in Python <https://scikit-learn.org/stable/index.html>`_\n- `dateutil: powerful extensions to datetime <https://dateutil.readthedocs.io/en/stable/>`_\n- `shapely: PostGIS-ish operations outside a database context for Python <http://toblerity.org/shapely/index.html>`_\n- `fiona: Python wrapper for vector data access functions from the OGR library <https://fiona.readthedocs.io/en/latest/manual.html>`_\n- `future: Compatibility layer between Python 2 and Python 3 <http://python-future.org/>`_\n- `boto3: Amazon Web Services (AWS) SDK for Python <https://boto3.amazonaws.com/v1/documentation/api/latest/index.html>`_\n- `s3fs: Pythonic file interface to S3 built on top of botocore <https://s3fs.readthedocs.io/en/latest/>`_\n- `lxml: processing XML and HTML in Python <https://pypi.python.org/pypi/lxml>`_\n- `paramiko: Native Python SSHv2 protocol library <http://www.paramiko.org>`_\n- `scp: scp module for paramiko <https://github.com/jbardin/scp.py>`_\n- `yapc: Python version of the NASA Goddard Space Flight Center YAPC Program <https://github.com/tsutterley/yapc>`_\n\nDownload\n########\n\n| The program homepage is:\n| https://github.com/tsutterley/read-icesat-2\n| A zip archive of the latest version is available directly at:\n| https://github.com/tsutterley/read-icesat-2/archive/main.zip\n\nDisclaimer\n##########\n\nThis project contains work and contributions from the `scientific community <./CONTRIBUTORS.rst>`_.\nThis program is not sponsored or maintained by the Universities Space Research Association (USRA) or NASA.\nIt is provided here for your convenience but *with no guarantees whatsoever*.\n\nLicense\n#######\n\nThe content of this project is licensed under the\n`Creative Commons Attribution 4.0 Attribution license <https://creativecommons.org/licenses/by/4.0/>`_\nand the source code is licensed under the `MIT license <LICENSE>`_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python tools for obtaining and working with elevation data from the NASA ICESat-2 mission",
"version": "1.3.1",
"project_urls": {
"Homepage": "https://github.com/tsutterley/read-ICESat-2"
},
"split_keywords": [
"icesat-2 laser altimetry",
"atlas",
"surface elevation and change"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eea693bca3f1a7902545acf7912978203035efd3db0e5264699579b0651c22aa",
"md5": "8b8bc1e4bfa14390de715ea817926d26",
"sha256": "e06fdff065fe53d7f0f73d75c9fc764dc2af298b3da7d4c613f002937df4fa72"
},
"downloads": -1,
"filename": "icesat2_toolkit-1.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b8bc1e4bfa14390de715ea817926d26",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 344046,
"upload_time": "2024-03-04T22:53:24",
"upload_time_iso_8601": "2024-03-04T22:53:24.007156Z",
"url": "https://files.pythonhosted.org/packages/ee/a6/93bca3f1a7902545acf7912978203035efd3db0e5264699579b0651c22aa/icesat2_toolkit-1.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "182f6f12714156f48294e87d4b4baa62d87c3c916ca377dcc28e58570c958a3a",
"md5": "a930a32938ec01dbd540ab1229c5e046",
"sha256": "4be385161bc8e213858b4f2608f4b9f2a666ba9d89515199cb4ec8c8211ece58"
},
"downloads": -1,
"filename": "icesat2-toolkit-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "a930a32938ec01dbd540ab1229c5e046",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 257177,
"upload_time": "2024-03-04T22:53:25",
"upload_time_iso_8601": "2024-03-04T22:53:25.704824Z",
"url": "https://files.pythonhosted.org/packages/18/2f/6f12714156f48294e87d4b4baa62d87c3c916ca377dcc28e58570c958a3a/icesat2-toolkit-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 22:53:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tsutterley",
"github_project": "read-ICESat-2",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "future",
"specs": []
},
{
"name": "lxml",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "paramiko",
"specs": []
},
{
"name": "pyproj",
"specs": []
},
{
"name": "python-dateutil",
"specs": []
},
{
"name": "scipy",
"specs": []
},
{
"name": "scp",
"specs": []
},
{
"name": "timescale",
"specs": []
}
],
"lcname": "icesat2-toolkit"
}
JSON
