1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
|
.. _api_reference:
API Reference
====================
The API Reference provides an overview of all public objects, functions and methods implemented in eodag.
.. toctree::
:hidden:
:maxdepth: 2
core
searchresult
eoproduct
assets
utils
exceptions
types
call_graphs
.. grid:: 1 2 2 3
:gutter: 4
.. grid-item-card:: :octicon:`globe;1.5em` EODataAccessGateway
:link: core
:link-type: doc
:text-align: center
:shadow: md
The main entry point for accessing Earth observation data. Handles configuration, catalog access, search, filtering, and download operations.
.. grid-item-card:: :octicon:`search;1.5em` SearchResult
:link: searchresult
:link-type: doc
:text-align: center
:shadow: md
Container for search results with filtering capabilities, conversion methods, and standardized interface for result manipulation.
.. grid-item-card:: :octicon:`package;1.5em` EOProduct
:link: eoproduct
:link-type: doc
:text-align: center
:shadow: md
Represents individual Earth observation products with download capabilities, format conversion, and pixel-level data access.
.. grid-item-card:: :octicon:`archive;1.5em` Assets
:link: assets
:link-type: doc
:text-align: center
:shadow: md
Manage product assets including AssetsDict and Asset classes for handling multi-file products and pixel access operations.
.. grid-item-card:: :octicon:`tools;1.5em` Utils
:link: utils
:link-type: doc
:text-align: center
:shadow: md
Utility functions for logging, callbacks, text search, notebook integration, S3 operations, xarray support, and miscellaneous helpers.
.. grid-item-card:: :octicon:`alert;1.5em` Exceptions
:link: exceptions
:link-type: doc
:text-align: center
:shadow: md
Complete set of custom exceptions for error handling including authentication, download, configuration, and validation errors.
.. grid-item-card:: :octicon:`code;1.5em` Types
:link: types
:link-type: doc
:text-align: center
:shadow: md
Type definitions, data models, and schema utilities for configuration management and type conversion between formats.
.. grid-item-card:: :octicon:`graph;1.5em` Call Graphs
:link: call_graphs
:link-type: doc
:text-align: center
:shadow: md
Visual representation of function call relationships and dependencies within the eodag codebase for development reference.
|