API Reference#

This page provides an auto-generated summary of icesat2db’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

Top-level functions#

`IceSat2Database`(config[, credentials])	Manages creation and operation of global TileDB arrays for IceSat2 data storage.
`IceSat2Granule`(download_path, data_info)	IceSat2Granule handles the processing and management of IceSat2 granules, including parsing, joining, and saving the data to TileDB, as well as querying processed granules from a database.
`IceSat2Processor`([geometry, start_date, ...])	IceSat2Processor class is responsible for processing IceSat2 granules, handling metadata, and writing data into the database.
`IceSat2Provider`([storage_type, s3_bucket, ...])	IceSat2Provider class to interface with IceSat2 data stored in TileDB, with support for flexible storage types.

Downloading functions#

`IceSat2Downloader`()	Base class for IceSat2 data downloaders.
`CMRDataDownloader`(geom[, start_date, ...])	Downloader for IceSat2 granules from NASA's CMR service.
`H5FileDownloader`([download_path])	Safe downloader for HDF5 files using thread-local Sessions and non-streaming chunked reads to avoid SSL segfaults in threaded mode.
`EarthDataAuthenticator`([earth_data_dir, strict])	Handles Earthdata authentication by managing .netrc and cookie files for automated login.
`CMRQuery`()	Base class for constructing and handling CMR queries.

ICESat-2 data processing functions#

`granule_handler`(file_path)	Represents a IceSat2 Granule HDF5 file, providing access to metadata and beams.
`GranuleParser`(file[, data_info])	Base class for parsing IceSat2 granule data into a GeoDataFrame.
`ATL08Granule`(file_path, field_mapping)	Represents a IceSat2 ATL08 granule, providing access to its beams and related data.
`beam_handler`(granule, beam, field_mapping)	Represents a single beam in a IceSat2 granule file, inheriting from h5py.Group.
`ATL08Beam`(granule, beam, field_mapping)	Represents a Level ATL08 IceSat2 beam and processes the beam data.
`IceSat2NameMetadata`(product, year, month, ...)	Container for metadata derived from IceSat2 file name conventions.

TileDB functions#

`TileDBProvider`([storage_type, s3_bucket, ...])	A base provider class for managing low-level interactions with TileDB arrays for IceSat2 data.
`SpatialConsolidationPlan`(plan_dict)
`SpatialConsolidationPlanner`()	Generate a spatial consolidation plan for a TileDB array.