Package structure overview

This section documents the general principles underpinning the organisation of the Eradiate Python package.

Main entry points

Core support [eradiate]

The top-level module contains basic support functions required to do almost anything with Eradiate.

Scene generation [eradiate.scenes]

This package exposes the scene generation components. It includes convenient interfaces to create objects representing the geometry, optical properties, illumination and measures in the scene on which you’ll run your radiative transfer simulation.

Experiments [eradiate.experiments]

In this package, you will find interfaces to trigger simulation runs, including pre- and post-processing operations.

Command-line interface [eradiate.cli]

This package contains the implementation of the Eradiate command-line interface.

Radiometric kernel

Kernel [eradiate.kernel]

This module provides functionality related with Eradiate’s radiometric kernel Mitsuba.

Data handling and visualization

Data handling [eradiate.data]

This package serves data shipped with Eradiate.

Post-processing pipeline definitions [eradiate.pipelines]

This package provides a post-processing pipeline framework used to convert raw sensor results yielded by kernel sensors to quantities of interest for Earth observation applications (e.g. reflectance). The data is stored as xarray labelled arrays (Dataset).

Plotting [eradiate.plot]

This module defines optional utility functions to create Matplotlib-based visualisations of Eradiate’s input and output data.

Physical properties

Radiative properties [eradiate.radprops]

This package provides abstractions used to define radiative properties used to create scenes.

Other support components

Numerical constants [eradiate.constants]

Various numerical constants used throughout the code base.

Class writing facilities [eradiate.{ attrs, converters, validators, _factory }]

These components are part of Eradiate’s core class writing system. It relies on the attrs library, extended for Pint compatibility by the Pinttrs library.

Exceptions [eradiate.exceptions]

Exception and warning definitions.

Math support [eradiate.{ frame, quad, warp }]

For the cases where Eradiate’s math dependencies and kernel are not enough, additional mathematical tools are provided.

Random number generation [eradiate.rng]

Support components for fine control of random number generation.

Unit support [eradiate.units]

Various utility functions and data variables used to safely handle unit conversions in Eradiate.

xarray utility functions [eradiate.xarray]

Various support components taking advantage of the xarray library.

Miscellaneous [eradiate.util]

Other support components which don’t fit in any of the aforementioned classification entries.