Skip to content

Commit 902b4fc

Browse files
tsutterleytsutterley
authored
refactor: ICESat-2 data product read programs under io (#69)
* refactor: ICESat-2 data product read programs under io * Update version.txt
1 parent 75cd2e2 commit 902b4fc

44 files changed

Lines changed: 2789 additions & 1774 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎doc/source/api_reference/convert.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==========
2-
convert.py
3-
==========
1+
=======
2+
convert
3+
=======
44

55
Utilities for converting ICESat-2 HDF5 files into different formats
66

‎doc/source/api_reference/convert_delta_time.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
=====================
2-
convert_delta_time.py
3-
=====================
1+
==================
2+
convert_delta_time
3+
==================
44

55
- Converts time from delta seconds into Julian and year-decimal
66

‎doc/source/api_reference/fit.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
======
2-
fit.py
3-
======
1+
===
2+
fit
3+
===
44

55
Utilities for calculating average fits from ATL03 Geolocated Photon Data
66

‎doc/source/api_reference/io/ATL03.rst‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
========
2+
io.ATL03
3+
========
4+
5+
- Reads ICESat-2 ATL03 Global Geolocated Photons
6+
- Interpolates ATL09 Atmospheric Characteristics to ATL03 segments
7+
8+
Calling Sequence
9+
################
10+
11+
.. code-block:: python
12+
13+
from icesat2_toolkit.io import ATL03
14+
IS2_atl03_mds,IS2_atl03_attrs,IS2_atl03_beams = ATL03.read_granule(FILENAME)
15+
16+
`Source code`__
17+
18+
.. __: https://github.com/tsutterley/read-ICESat-2/blob/main/icesat2_toolkit/io/ATL03.py
19+
20+
.. autofunction:: icesat2_toolkit.io.ATL03.read_granule
21+
22+
.. autofunction:: icesat2_toolkit.io.ATL03.interpolate_ATL09
23+
24+
.. autofunction:: icesat2_toolkit.io.ATL03.find_beams
25+
26+
.. autofunction:: icesat2_toolkit.io.ATL03.read_main
27+
28+
.. autofunction:: icesat2_toolkit.io.ATL03.read_beam

‎doc/source/api_reference/io/ATL06.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
========
2+
io.ATL06
3+
========
4+
5+
- Reads ICESat-2 ATL06 Land Ice Elevation data files
6+
7+
Calling Sequence
8+
################
9+
10+
.. code-block:: python
11+
12+
from icesat2_toolkit.io import ATL06
13+
IS2_atl06_mds,IS2_atl06_attrs,IS2_atl06_beams = ATL06.read_granule(FILENAME)
14+
15+
`Source code`__
16+
17+
.. __: https://github.com/tsutterley/read-ICESat-2/blob/main/icesat2_toolkit/io/ATL06.py
18+
19+
.. autofunction:: icesat2_toolkit.io.ATL06.read_granule
20+
21+
.. autofunction:: icesat2_toolkit.io.ATL06.find_beams
22+
23+
.. autofunction:: icesat2_toolkit.io.ATL06.read_beam

‎doc/source/api_reference/io/ATL07.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
========
2+
io.ATL07
3+
========
4+
5+
- Reads ICESat-2 ATL07 Sea Ice Height data files
6+
7+
Calling Sequence
8+
################
9+
10+
.. code-block:: python
11+
12+
from icesat2_toolkit.io import ATL07
13+
IS2_atl07_mds,IS2_atl07_attrs,IS2_atl07_beams = ATL07.read_granule(FILENAME)
14+
15+
`Source code`__
16+
17+
.. __: https://github.com/tsutterley/read-ICESat-2/blob/main/icesat2_toolkit/io/ATL07.py
18+
19+
.. autofunction:: icesat2_toolkit.io.ATL07.read_granule
20+
21+
.. autofunction:: icesat2_toolkit.io.ATL07.find_beams
22+
23+
.. autofunction:: icesat2_toolkit.io.ATL07.read_beam

‎doc/source/api_reference/io/ATL10.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
========
2+
io.ATL10
3+
========
4+
5+
- Reads ICESat-2 ATL10 Sea Ice Freeboard data files
6+
7+
Calling Sequence
8+
################
9+
10+
.. code-block:: python
11+
12+
from icesat2_toolkit.io import ATL10
13+
IS2_atl10_mds,IS2_atl10_attrs,IS2_atl10_beams = ATL10.read_granule(FILENAME)
14+
15+
`Source code`__
16+
17+
.. __: https://github.com/tsutterley/read-ICESat-2/blob/main/icesat2_toolkit/io/ATL10.py
18+
19+
.. autofunction:: icesat2_toolkit.io.ATL10.read_granule
20+
21+
.. autofunction:: icesat2_toolkit.io.ATL10.find_beams
22+
23+
.. autofunction:: icesat2_toolkit.io.ATL10.read_beam

‎doc/source/api_reference/io/ATL11.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
========
2+
io.ATL11
3+
========
4+
5+
- Reads ICESat-2 ATL11 Annual Land Ice Height data files
6+
7+
.. code-block:: python
8+
9+
from icesat2_toolkit.io import ATL11
10+
IS2_atl11_mds,IS2_atl11_attrs,IS2_atl11_pairs = ATL11.read_granule(FILENAME,
11+
GROUPS=['cycle_stats','crossing_track_data'], VERBOSE=True)
12+
13+
`Source code`__
14+
15+
.. __: https://github.com/tsutterley/read-ICESat-2/blob/main/icesat2_toolkit/io/ATL11.py
16+
17+
.. autofunction:: icesat2_toolkit.io.ATL11.read_granule
18+
19+
.. autofunction:: icesat2_toolkit.io.ATL11.find_pairs
20+
21+
.. autofunction:: icesat2_toolkit.io.ATL11.read_pair

‎doc/source/api_reference/io/ATL12.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
========
2+
io.ATL12
3+
========
4+
5+
- Reads ICESat-2 ATL12 Ocean Surface Height data files
6+
7+
.. code-block:: python
8+
9+
from icesat2_toolkit.io import ATL12
10+
IS2_atl12_mds,IS2_atl12_attrs,IS2_atl12_beams = ATL12.read_granule(FILENAME)
11+
12+
`Source code`__
13+
14+
.. __: https://github.com/tsutterley/read-ICESat-2/blob/main/icesat2_toolkit/io/ATL12.py
15+
16+
.. autofunction:: icesat2_toolkit.io.ATL12.read_granule
17+
18+
.. autofunction:: icesat2_toolkit.io.ATL12.find_beams
19+
20+
.. autofunction:: icesat2_toolkit.io.ATL12.read_beam

‎doc/source/api_reference/read_ICESat2_ATL03.rst‎

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)