API ReferenceOutputs Object

Outputs Object

The Outputs object is returned by run_model() and run_emulator(). It contains spectral albedo, broadband values, subsurface fluxes, and convenience methods.

Attributes

AttributeTypeDescription
albedolist or ndarray (480,)Spectral albedo
BBAfloatBroadband albedo (flux-weighted)
BBAVISfloatVisible broadband albedo (0.3–0.7 µm)
BBANIRfloatNIR broadband albedo (0.7–5.0 µm)
flx_slrndarray (480,)Solar flux spectrum
F_upndarray (480, N+1)Spectral upwelling flux at layer interfaces
F_dwnndarray (480, N+1)Spectral downwelling flux at layer interfaces

F_up and F_dwn are only available from the full forward model, not the emulator.

Methods

.to_platform(platform)

Convolve spectral albedo to satellite or climate model bands.

s2 = outputs.to_platform("sentinel2")
print(s2.B3, s2.NDSI)

Returns a BandResult.

.par(depth_m=0.0)

Photosynthetically active radiation (400–700 nm) at a given depth.

par_surface = outputs.par(0.0)
par_profile = outputs.par([0.0, 0.05, 0.1, 0.5])

.subsurface_flux(depth_m)

Spectral fluxes at an arbitrary depth by linear interpolation.

flux = outputs.subsurface_flux(0.03)
print(flux["F_dwn"].shape)  # (480,)
print(flux["F_up"].shape)   # (480,)
print(flux["F_net"].shape)  # (480,)

.spectral_heating_rate()

Spectral radiative heating rate per layer (K/hr per band).

heating = outputs.spectral_heating_rate()
print(heating.shape)  # (480, N_layers)