Skip to main content
Ctrl+K
 - Home  - Home

Users

  • User guide
    • Installation
    • Basic concepts and terminology
    • Configuration
    • Package structure overview
    • One-dimensional experiment features
    • Digital elevation model support
    • Canopy scene loader
    • Spectral discretization
    • Conventions in Eradiate
    • Unit handling for users
  • Tutorials
    • Getting started
      • First steps with Eradiate
      • Molecular atmosphere basics
      • Particle layer basics
      • 3D simulation basics
      • Problem geometry control
    • Advanced topics
      • Post-processing pipelines
      • Building abstract canopies
    • How-to guides
      • A better notebook experience
      • Advanced visualisation
      • Filter a spectral response function

Reference

  • API reference
    • eradiate
    • eradiate.attrs
    • eradiate.config
    • eradiate.constants
    • eradiate.contexts
      • eradiate.contexts.Context
      • eradiate.contexts.KernelContext
    • eradiate.converters
    • eradiate.data
      • eradiate.data.init_data_store
      • eradiate.data.open_dataset
      • eradiate.data.load_dataset
      • eradiate.data.DataStore
      • eradiate.data.BlindDirectoryDataStore
      • eradiate.data.BlindOnlineDataStore
      • eradiate.data.SafeDirectoryDataStore
      • eradiate.data.SafeOnlineDataStore
      • eradiate.data.MultiDataStore
    • eradiate.exceptions
    • eradiate.experiments
      • eradiate.experiments.AtmosphereExperiment
      • eradiate.experiments.CanopyExperiment
      • eradiate.experiments.CanopyAtmosphereExperiment
      • eradiate.experiments.DEMExperiment
      • eradiate.experiments.Experiment
      • eradiate.experiments.EarthObservationExperiment
      • eradiate.experiments.run
    • eradiate.frame
    • eradiate.kernel
      • eradiate.kernel.InitParameter
      • eradiate.kernel.KernelDictTemplate
      • eradiate.kernel.UpdateParameter
      • eradiate.kernel.TypeIdLookupStrategy
      • eradiate.kernel.UpdateMapTemplate
      • eradiate.kernel.MitsubaObjectWrapper
      • eradiate.kernel.mi_traverse
      • eradiate.kernel.mi_render
      • eradiate.kernel.bitmap_to_dataarray
      • eradiate.kernel.bitmap_to_dataset
      • eradiate.kernel.eval_bsdf
      • eradiate.kernel.install_logging
      • eradiate.kernel.map_cube
      • eradiate.kernel.map_unit_cube
      • eradiate.kernel.read_binary_grid3d
      • eradiate.kernel.write_binary_grid3d
    • eradiate.notebook
    • eradiate.pipelines
      • eradiate.pipelines.config
      • eradiate.pipelines.driver
      • eradiate.pipelines.list_variables
      • eradiate.pipelines.outputs
    • eradiate.plot
      • eradiate.plot.dashboard_particle_dataset
      • eradiate.plot.detect_axes
      • eradiate.plot.get_axes_from_facet_grid
      • eradiate.plot.make_ticks
      • eradiate.plot.remove_xylabels
      • eradiate.plot.remove_xyticks
      • eradiate.plot.set_style
    • eradiate.quad
    • eradiate.radprops
      • eradiate.radprops.rayleigh
        • eradiate.radprops.rayleigh.air_refractive_index
        • eradiate.radprops.rayleigh.compute_sigma_s_air
      • eradiate.radprops.ZGrid
      • eradiate.radprops.RadProfile
      • eradiate.radprops.AtmosphereRadProfile
      • eradiate.radprops.AbsorptionDatabase
      • eradiate.radprops.MonoAbsorptionDatabase
      • eradiate.radprops.CKDAbsorptionDatabase
      • eradiate.radprops.ErrorHandlingConfiguration
    • eradiate.rng
    • eradiate.scenes
      • eradiate.scenes.core.traverse
      • eradiate.scenes.core.SceneTraversal
      • eradiate.scenes.core.Ref
      • eradiate.scenes.core.Scene
      • eradiate.scenes.core.SceneElement
      • eradiate.scenes.core.NodeSceneElement
      • eradiate.scenes.core.InstanceSceneElement
      • eradiate.scenes.core.CompositeSceneElement
      • eradiate.scenes.core.BoundingBox
      • eradiate.scenes.geometry.SceneGeometry
      • eradiate.scenes.geometry.PlaneParallelGeometry
      • eradiate.scenes.geometry.SphericalShellGeometry
      • eradiate.scenes.atmosphere.Atmosphere
      • eradiate.scenes.atmosphere.AbstractHeterogeneousAtmosphere
      • eradiate.scenes.atmosphere.ParticleDistribution
      • eradiate.scenes.atmosphere.HomogeneousAtmosphere
      • eradiate.scenes.atmosphere.HeterogeneousAtmosphere
      • eradiate.scenes.atmosphere.MolecularAtmosphere
      • eradiate.scenes.atmosphere.ParticleLayer
      • eradiate.scenes.atmosphere.ArrayParticleDistribution
      • eradiate.scenes.atmosphere.ExponentialParticleDistribution
      • eradiate.scenes.atmosphere.InterpolatorParticleDistribution
      • eradiate.scenes.atmosphere.GaussianParticleDistribution
      • eradiate.scenes.atmosphere.UniformParticleDistribution
      • eradiate.scenes.atmosphere.eval_transmittance_mono
      • eradiate.scenes.atmosphere.eval_transmittance_ckd
      • eradiate.scenes.biosphere.Canopy
      • eradiate.scenes.biosphere.CanopyElement
      • eradiate.scenes.biosphere.AbstractTree
      • eradiate.scenes.biosphere.DiscreteCanopy
      • eradiate.scenes.biosphere.InstancedCanopyElement
      • eradiate.scenes.biosphere.LeafCloud
      • eradiate.scenes.biosphere.MeshTree
      • eradiate.scenes.biosphere.MeshTreeElement
      • eradiate.scenes.biosphere._leaf_cloud.ConeLeafCloudParams
      • eradiate.scenes.biosphere._leaf_cloud.CuboidLeafCloudParams
      • eradiate.scenes.biosphere._leaf_cloud.CylinderLeafCloudParams
      • eradiate.scenes.biosphere._leaf_cloud.EllipsoidLeafCloudParams
      • eradiate.scenes.biosphere._leaf_cloud.SphereLeafCloudParams
      • eradiate.scenes.biosphere.load_scenario
      • eradiate.scenes.biosphere.load_rami_scenario
      • eradiate.scenes.biosphere.RAMIActualCanopies
      • eradiate.scenes.biosphere.RAMIHeterogeneousAbstractCanopies
      • eradiate.scenes.biosphere.RAMIHomogeneousAbstractCanopies
      • eradiate.scenes.biosphere.RAMIScenarioVersion
      • eradiate.scenes.biosphere.wellington_citrus_orchard
      • eradiate.scenes.surface.Surface
      • eradiate.scenes.surface.BasicSurface
      • eradiate.scenes.surface.CentralPatchSurface
      • eradiate.scenes.surface.DEMSurface
      • eradiate.scenes.surface.mesh_from_dem
      • eradiate.scenes.surface.triangulate_grid
      • eradiate.scenes.bsdfs.BSDF
      • eradiate.scenes.bsdfs.BlackBSDF
      • eradiate.scenes.bsdfs.CheckerboardBSDF
      • eradiate.scenes.bsdfs.HapkeBSDF
      • eradiate.scenes.bsdfs.LambertianBSDF
      • eradiate.scenes.bsdfs.MQDiffuseBSDF
      • eradiate.scenes.bsdfs.OpacityMaskBSDF
      • eradiate.scenes.bsdfs.RPVBSDF
      • eradiate.scenes.bsdfs.RTLSBSDF
      • eradiate.scenes.shapes.Shape
      • eradiate.scenes.shapes.ShapeNode
      • eradiate.scenes.shapes.ShapeInstance
      • eradiate.scenes.shapes.BufferMeshShape
      • eradiate.scenes.shapes.CuboidShape
      • eradiate.scenes.shapes.FileMeshShape
      • eradiate.scenes.shapes.RectangleShape
      • eradiate.scenes.shapes.SphereShape
      • eradiate.scenes.illumination.Illumination
      • eradiate.scenes.illumination.AbstractDirectionalIllumination
      • eradiate.scenes.illumination.DirectionalIllumination
      • eradiate.scenes.illumination.AstroObjectIllumination
      • eradiate.scenes.illumination.ConstantIllumination
      • eradiate.scenes.illumination.SpotIllumination
      • eradiate.scenes.measure.Measure
      • eradiate.scenes.measure.Target
      • eradiate.scenes.measure.DistantMeasure
      • eradiate.scenes.measure.MultiDistantMeasure
      • eradiate.scenes.measure.MultiPixelDistantMeasure
      • eradiate.scenes.measure.DistantFluxMeasure
      • eradiate.scenes.measure.HemisphericalDistantMeasure
      • eradiate.scenes.measure.RadiancemeterMeasure
      • eradiate.scenes.measure.MultiRadiancemeterMeasure
      • eradiate.scenes.measure.PerspectiveCameraMeasure
      • eradiate.scenes.measure.TargetPoint
      • eradiate.scenes.measure.TargetRectangle
      • eradiate.scenes.measure.Layout
      • eradiate.scenes.measure.AngleLayout
      • eradiate.scenes.measure.AzimuthRingLayout
      • eradiate.scenes.measure.DirectionLayout
      • eradiate.scenes.measure.GridLayout
      • eradiate.scenes.measure.HemispherePlaneLayout
      • eradiate.scenes.phase.PhaseFunction
      • eradiate.scenes.phase.IsotropicPhaseFunction
      • eradiate.scenes.phase.RayleighPhaseFunction
      • eradiate.scenes.phase.HenyeyGreensteinPhaseFunction
      • eradiate.scenes.phase.BlendPhaseFunction
      • eradiate.scenes.phase.TabulatedPhaseFunction
      • eradiate.scenes.integrators.Integrator
      • eradiate.scenes.integrators.PathIntegrator
      • eradiate.scenes.integrators.PiecewiseVolPathIntegrator
      • eradiate.scenes.integrators.VolPathIntegrator
      • eradiate.scenes.integrators.VolPathMISIntegrator
      • eradiate.scenes.spectra.Spectrum
      • eradiate.scenes.spectra._core.SpectrumFactory
      • eradiate.scenes.spectra.UniformSpectrum
      • eradiate.scenes.spectra.InterpolatedSpectrum
      • eradiate.scenes.spectra.SolarIrradianceSpectrum
      • eradiate.scenes.spectra.AirScatteringCoefficientSpectrum
    • eradiate.spectral
      • eradiate.spectral.SpectralGrid
      • eradiate.spectral.MonoSpectralGrid
      • eradiate.spectral.CKDSpectralGrid
      • eradiate.spectral.SpectralResponseFunction
      • eradiate.spectral.UniformSRF
      • eradiate.spectral.BandSRF
      • eradiate.spectral.DeltaSRF
      • eradiate.spectral.response.make_gaussian
      • eradiate.spectral.SpectralIndex
      • eradiate.spectral.MonoSpectralIndex
      • eradiate.spectral.CKDSpectralIndex
      • eradiate.spectral.CKDQuadConfig
      • eradiate.spectral.CKDQuadPolicy
    • eradiate.srf_tools
    • eradiate.test_tools
      • eradiate.test_tools.plugin.sample_eval_pdf_bsdf
      • eradiate.test_tools.regression.RegressionTest
      • eradiate.test_tools.regression.RMSETest
      • eradiate.test_tools.regression.Chi2Test
      • eradiate.test_tools.types.check_scene_element
    • eradiate.units
    • eradiate.util
    • eradiate.validators
    • eradiate.warp
    • eradiate.xarray
      • eradiate.xarray.interp.dataarray_to_rgb
      • eradiate.xarray.interp.film_to_angular
      • eradiate.xarray._accessors.EradiateDataArrayAccessor
    • eradiate._factory
      • eradiate.scenes.atmosphere.atmosphere_factory
      • eradiate.scenes.atmosphere.particle_distribution_factory
      • eradiate.scenes.biosphere.biosphere_factory
      • eradiate.scenes.bsdfs.bsdf_factory
      • eradiate.scenes.illumination.illumination_factory
      • eradiate.scenes.integrators.integrator_factory
      • eradiate.scenes.measure.measure_factory
      • eradiate.scenes.phase.phase_function_factory
      • eradiate.scenes.shapes.shape_factory
      • eradiate.scenes.spectra.spectrum_factory
      • eradiate.scenes.surface.surface_factory
    • eradiate._mode
      • eradiate._mode.Mode
      • eradiate._mode.ModeFlag
      • eradiate._mode.SubtypeDispatcher
  • Plugin reference
    • BSDFs
      • Bi-Lambertian material (bilambertian)
      • Hapke surface model (hapke)
      • Measured quasi-diffuse material (mqdiffuse)
      • Rahman Pinty Verstraete reflection model (rpv)
      • Ross-Thick Li-Sparse reflection model (rtls)
      • Selector material (selectbsdf)
    • Emitters
      • Distant astronomical object (astroobject)
    • Integrators
      • Piecewise volumetric path tracer (volpath)
    • Media
      • Piecewise medium (piecewise)
    • Phase functions
      • Rayleigh phase function (rayleigh_polarized)
      • Tabulated phase function (irregular angular grid) (tabphase_irregular)
      • Lookup table (polarized) phase function (tabphase_polarized)
    • Sensors
      • Distant fluxmeter sensor (distantflux)
      • Hemispherical distant radiancemeter sensor (hdistant)
      • Multi distant radiance meter (mdistant)
      • Multi-pixel distant radiancemeter sensor (mpdistant)
      • Multi-radiance meter (mradiancemeter)
    • Volume data sources
      • Mapping to spherical coordinates (sphericalcoordsvolume)
  • Command-line interface reference
  • Release notes
    • v0.29.x series (current stable)
    • v0.28.x series
    • v0.27.x series
    • v0.26.x series
    • v0.25.x series
    • v0.24.x series
    • v0.23.x and older
  • Bibliography

Data

  • Introduction
    • Data format details
  • Atmosphere: Aerosols / particles
  • Atmosphere: Molecular absorption
  • Atmosphere: Thermophysical properties
  • Solar irradiance
  • Spectral response functions
  • RAMI benchmark scenes

Developers/contributors

  • Contributing to Eradiate
  • Dependencies
  • Maintainer guide
  • Developer guides
    • Development installation
    • Update guide
    • Scene generator design
    • Factory guide
    • Lazy module imports
    • Radiometric kernel interface
    • Design note: atmosphere
    • Benchmarking
  • Repository
  • Open issue
  • .md

Getting started

Getting started#

A collection of introductory lessons to learn the basics of Eradiate.

First steps with Eradiate
Molecular atmosphere basics
Particle layer basics
3D simulation basics
Problem geometry control

previous

Tutorials

next

First steps with Eradiate

Eradiate v0.29.2 © Copyright 2020-2024, The Eradiate Team.
Created using Sphinx 7.4.7.