Skip to main content
Ctrl+K
Logo image

Users

  • Getting started
    • Installation guide
    • Update guide
    • Docker guide
  • User guide
    • Basic concepts and terminology
    • Conventions in Eradiate
    • Package structure overview
    • One-dimensional experiment features
    • Unit handling for users
    • Data guide
      • Introduction
      • Absorption cross section
        • us76_u86_4-spectra
      • Atmosphere: radiative properties
      • Atmosphere: thermophysical properties
      • Correlated-k distribution (CKD)
      • Particle radiative properties
      • Solar irradiance spectra
      • Spectral response function
  • Tutorials
    • Getting started
      • First steps with Eradiate
      • Molecular atmosphere basics
      • Particle layer basics
      • 3D simulation basics
      • Problem geometry control
    • Advanced topics
      • Building abstract canopies
    • How-to guides
      • A better notebook experience
      • Advanced visualisation
      • Filter a spectral response function

Reference

  • API reference
    • eradiate
    • eradiate.attrs
    • eradiate.ckd
      • eradiate.ckd.BinSet
      • eradiate.ckd.Bin
      • eradiate.ckd.Bindex
      • eradiate.ckd.bin_filter
      • eradiate.ckd.bin_filter_ids
      • eradiate.ckd.bin_filter_interval
    • eradiate.constants
    • eradiate.contexts
      • eradiate.contexts.Context
      • eradiate.contexts.KernelDictContext
      • eradiate.contexts.SpectralContext
      • eradiate.contexts.MonoSpectralContext
      • eradiate.contexts.CKDSpectralContext
    • 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_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.Pipeline
      • eradiate.pipelines.PipelineStep
      • eradiate.pipelines.Gather
      • eradiate.pipelines.AggregateCKDQuad
      • eradiate.pipelines.AggregateRadiosity
      • eradiate.pipelines.AddViewingAngles
      • eradiate.pipelines.AddIllumination
      • eradiate.pipelines.AddSpectralResponseFunction
      • eradiate.pipelines.ComputeReflectance
      • eradiate.pipelines.ComputeAlbedo
      • eradiate.pipelines.ApplySpectralResponseFunction
    • eradiate.plot
      • 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.absorption
        • eradiate.radprops.absorption.compute_sigma_a
      • eradiate.radprops.rayleigh
        • eradiate.radprops.rayleigh.air_refractive_index
        • eradiate.radprops.rayleigh.compute_sigma_s_air
      • eradiate.radprops.ZGrid
      • eradiate.radprops.RadProfile
      • eradiate.radprops.AFGL1986RadProfile
      • eradiate.radprops.US76ApproxRadProfile
    • 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.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.surface.Surface
      • eradiate.scenes.surface.BasicSurface
      • eradiate.scenes.surface.CentralPatchSurface
      • eradiate.scenes.bsdfs.BSDF
      • eradiate.scenes.bsdfs.BlackBSDF
      • eradiate.scenes.bsdfs.CheckerboardBSDF
      • eradiate.scenes.bsdfs.LambertianBSDF
      • eradiate.scenes.bsdfs.MQDiffuseBSDF
      • eradiate.scenes.bsdfs.RPVBSDF
      • eradiate.scenes.shapes.Shape
      • eradiate.scenes.shapes.ShapeNode
      • eradiate.scenes.shapes.ShapeInstance
      • eradiate.scenes.shapes.CuboidShape
      • eradiate.scenes.shapes.RectangleShape
      • eradiate.scenes.shapes.SphereShape
      • eradiate.scenes.illumination.Illumination
      • eradiate.scenes.illumination.DirectionalIllumination
      • eradiate.scenes.illumination.ConstantIllumination
      • eradiate.scenes.illumination.SpotIllumination
      • eradiate.scenes.measure.Measure
      • eradiate.scenes.measure.Target
      • eradiate.scenes.measure.MeasureSpectralConfig
      • eradiate.scenes.measure._core.MonoMeasureSpectralConfig
      • eradiate.scenes.measure._core.CKDMeasureSpectralConfig
      • eradiate.scenes.measure.MultiDistantMeasure
      • 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.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.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.thermoprops
      • eradiate.thermoprops.afgl_1986
        • eradiate.thermoprops.afgl_1986.make_profile
      • eradiate.thermoprops.us76
        • eradiate.thermoprops.us76.compute_gravity
        • eradiate.thermoprops.us76.compute_high_altitude
        • eradiate.thermoprops.us76.compute_levels_temperature_and_pressure_low_altitude
        • eradiate.thermoprops.us76.compute_low_altitude
        • eradiate.thermoprops.us76.compute_mean_molar_mass_high_altitude
        • eradiate.thermoprops.us76.compute_number_densities_high_altitude
        • eradiate.thermoprops.us76.compute_pressure_low_altitude
        • eradiate.thermoprops.us76.compute_pressure_low_altitude_non_zero_gradient
        • eradiate.thermoprops.us76.compute_pressure_low_altitude_zero_gradient
        • eradiate.thermoprops.us76.compute_temperature_gradient_high_altitude
        • eradiate.thermoprops.us76.compute_temperature_high_altitude
        • eradiate.thermoprops.us76.compute_temperature_low_altitude
        • eradiate.thermoprops.us76.create
        • eradiate.thermoprops.us76.eddy_diffusion_coefficient
        • eradiate.thermoprops.us76.f_above_115_km
        • eradiate.thermoprops.us76.f_below_115_km
        • eradiate.thermoprops.us76.init_data_set
        • eradiate.thermoprops.us76.log_interp1d
        • eradiate.thermoprops.us76.make_profile
        • eradiate.thermoprops.us76.tau_function
        • eradiate.thermoprops.us76.thermal_diffusion_coefficient
        • eradiate.thermoprops.us76.thermal_diffusion_term
        • eradiate.thermoprops.us76.thermal_diffusion_term_atomic_oxygen
        • eradiate.thermoprops.us76.to_altitude
        • eradiate.thermoprops.us76.to_geopotential_height
        • eradiate.thermoprops.us76.velocity_term
        • eradiate.thermoprops.us76.velocity_term_atomic_oxygen
        • eradiate.thermoprops.us76.velocity_term_hump
        • eradiate.thermoprops.us76.velocity_term_no_hump
      • eradiate.thermoprops.util
        • eradiate.thermoprops.util.column_mass_density
        • eradiate.thermoprops.util.column_number_density
        • eradiate.thermoprops.util.compute_scaling_factors
        • eradiate.thermoprops.util.equilibrium_water_vapor_fraction
        • eradiate.thermoprops.util.human_readable
        • eradiate.thermoprops.util.interpolate
        • eradiate.thermoprops.util.make_profile_regular
        • eradiate.thermoprops.util.mass_density_at_surface
        • eradiate.thermoprops.util.number_density_at_surface
        • eradiate.thermoprops.util.rescale_concentration
        • eradiate.thermoprops.util.volume_mixing_ratio_at_surface
        • eradiate.thermoprops.util.water_vapor_saturation_pressure
    • 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._config
      • Environment variables
    • eradiate._factory
      • eradiate.radprops.rad_profile_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.SpectralMode
      • eradiate._mode.MitsubaBackend
      • eradiate._mode.MitsubaColorMode
  • Plugin reference
    • BSDFs
      • Bi-Lambertian material (bilambertian)
      • Measured quasi-diffuse material (mqdiffuse)
      • Rahman Pinty Verstraete reflection model (rpv)
    • Phase functions
      • Tabulated phase function (irregular angular grid) (tabphase_irregular)
    • Sensors
      • Distant fluxmeter sensor (distantflux)
      • Hemispherical distant radiancemeter sensor (hdistant)
      • Multi distant radiance meter (mdistant)
      • Multi-radiance meter (mradiancemeter)
    • Volume data sources
      • Mapping to spherical coordinates (sphericalcoordsvolume)
  • Command-line interface reference
  • What’s new?
  • Bibliography

Developers/contributors

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

User guide

User guide#

  • Basic concepts and terminology
  • Conventions in Eradiate
  • Package structure overview
  • One-dimensional experiment features
  • Unit handling for users
  • Data guide

previous

Docker guide

next

Basic concepts and terminology

Eradiate v0.23.1.post1.dev0+g3d22aa1.d20230427 © Copyright 2020-2023, The Eradiate Team.
Created using Sphinx 5.0.0.