stilt.Simulation.transport_error#

Simulation.transport_error(error, flux, **options)[source]#

Return the transport error of this simulation’s modeled enhancement.

It is the extra spread in the per-particle enhancement that a wind-error variant of the same receptor adds (Lin and Gerbig, 2005). See stilt.particles.transport_error(), which documents the options (levels, length_scale, percentile, noise_splits, background).

Parameters:

  • error (Simulation | Sequence[Simulation]) – The same receptor under a wind-error variant, or every realization of one.

  • flux (DataArray) – Surface flux field, in µmol m⁻² s⁻¹.

  • options (Any)

Return type:

TransportError

Examples

>>> err = project.simulation(sim.receptor.id, "hrrr-err")
>>> sim.transport_error(err, flux).variance
>>> ensemble = [
...     project.simulation(rid, "hrrr-err", k) for k in range(10)
... ]
>>> sim.transport_error(ensemble, flux)