Variables#

The summary table and detailed descriptions are auto-generated using the data from variables.yml and module crt1d.variables.

Summary#

Click on a “name” to jump to the details.

Summary table#

name

units

shape

long_name

aI

W m\(^{-2}\)

\((n_z-1, n_\lambda)\)

Absorbed irradiance

aI_df

W m\(^{-2}\)

\((n_z-1, n_\lambda)\)

Absorbed diffuse irradiance

aI_df_lsh

W m\(^{-2}\)

\((n_z-1, n_\lambda)\)

Absorbed irradiance by shaded leaves

aI_df_lsl

W m\(^{-2}\)

\((n_z-1, n_\lambda)\)

Absorbed irradiance by sunlit leaves

aI_df_sh

W m\(^{-2}\)

\((n_z-1, n_\lambda)\)

Absorbed diffuse irradiance by shaded leaves

aI_df_sl

W m\(^{-2}\)

\((n_z-1, n_\lambda)\)

Absorbed diffuse irradiance by sunlit leaves

aI_dr

W m\(^{-2}\)

\((n_z-1, n_\lambda)\)

Absorbed direct irradiance

aI_l

W m\(^{-2}\)

\((n_z-1, n_\lambda)\)

Absorbed irradiance

aI_lsh

W m\(^{-2}\)

\((n_z-1, n_\lambda)\)

Absorbed irradiance by shaded leaves

aI_lsl

W m\(^{-2}\)

\((n_z-1, n_\lambda)\)

Absorbed irradiance by sunlit leaves

aI_sh

W m\(^{-2}\)

\((n_z-1, n_\lambda)\)

Absorbed irradiance by shaded leaves

aI_sl

W m\(^{-2}\)

\((n_z-1, n_\lambda)\)

Absorbed irradiance by sunlit leaves

clump

1

Clump factor

dlai

m\(^{2}\) m\(^{-2}\)

\((n_z-1,)\)

Leaf area index in layer

dwl

μm

\((n_\lambda,)\)

Wavelength band width

F

W m\(^{-2}\)

\((n_z, n_\lambda)\)

Actinic flux (binned)

f_slm

1

\((n_z-1,)\)

Sunlit leaf fraction

G

Fractional leaf area in the psi direction

G_fn

I_d

W m\(^{-2}\)

\((n_z, n_\lambda)\)

Downward irradiance

I_df0_all

W m\(^{-2}\)

\((n_\lambda,)\)

Incoming diffuse irradiance at top-of-canopy

I_df_d

W m\(^{-2}\)

\((n_z, n_\lambda)\)

Downward diffuse irradiance (binned)

I_df_u

W m\(^{-2}\)

\((n_z, n_\lambda)\)

Upward diffuse irradiance (binned)

I_dr

W m\(^{-2}\)

\((n_z, n_\lambda)\)

Direct beam irradiance (binned)

I_dr0_all

W m\(^{-2}\)

\((n_\lambda,)\)

Incoming direct irradiance at top-of-canopy

K_b

Black leaf attenuation coefficient

K_b_fn

lad

m\(^{2}\) m\(^{-3}\)

\((n_z-1,)\)

Leaf area density

lai

m\(^{2}\) m\(^{-2}\)

\((n_z,)\)

Leaf area index (cumulative)

laim

m\(^{2}\) m\(^{-2}\)

\((n_z-1,)\)

Leaf area index (cumulative)

leaf_r

1

\((n_\lambda,)\)

Leaf reflectance

leaf_t

1

\((n_\lambda,)\)

Leaf transmittance

mla

deg

Mean leaf angle

mu

cos(psi)

psi

radians

Solar zenith angle

soil_r

1

\((n_\lambda,)\)

sza

deg

Solar zenith angle

wl

μm

\((n_\lambda,)\)

Wavelength

wle

μm

\((n_\lambda+1,)\)

Wavelength of irradiance band edges

z

m

\((n_z,)\)

Height above ground

zm

m

\((n_z-1,)\)

Height above ground

Detailed#

Detailed descriptions.

aI#

Layerwise absorbed irradiance.

Attributes:

  • long_name: Absorbed irradiance

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_z-1, n_wl)

  • dims: ['zm', 'wl']

aI_df#

Layerwise absorbed diffuse irradiance.

Attributes:

  • long_name: Absorbed diffuse irradiance

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_z-1, n_wl)

  • dims: ['zm', 'wl']

aI_df_lsh#

Layerwise absorbed diffuse irradiance by shaded leaves per unit leaf area.

Attributes:

  • long_name: Absorbed irradiance by shaded leaves

  • units: W m\(^{-2}\)

  • detailed units: W (m\(^{2}\) leaf)\(^{-1}\)

  • type: array_like

  • shape: (n_z-1, n_wl)

  • dims: ['zm', 'wl']

aI_df_lsl#

Layerwise absorbed diffuse irradiance by sunlit leaves per unit leaf area.

Attributes:

  • long_name: Absorbed irradiance by sunlit leaves

  • units: W m\(^{-2}\)

  • detailed units: W (m\(^{2}\) leaf)\(^{-1}\)

  • type: array_like

  • shape: (n_z-1, n_wl)

  • dims: ['zm', 'wl']

aI_df_sh#

Layerwise absorbed diffuse irradiance by shaded leaves. Not per unit leaf area.

Attributes:

  • long_name: Absorbed diffuse irradiance by shaded leaves

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_z-1, n_wl)

  • dims: ['zm', 'wl']

aI_df_sl#

Layerwise absorbed diffuse irradiance by sunlit leaves. Not per unit leaf area.

Attributes:

  • long_name: Absorbed diffuse irradiance by sunlit leaves

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_z-1, n_wl)

  • dims: ['zm', 'wl']

aI_dr#

Layerwise absorbed direct irradiance.

Attributes:

  • long_name: Absorbed direct irradiance

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_z-1, n_wl)

  • dims: ['zm', 'wl']

aI_l#

Layerwise absorbed irradiance per units leaf area.

Attributes:

  • long_name: Absorbed irradiance

  • units: W m\(^{-2}\)

  • detailed units: W (m\(^{2}\) leaf)\(^{-1}\)

  • type: array_like

  • shape: (n_z-1, n_wl)

  • dims: ['zm', 'wl']

aI_lsh#

Layerwise absorbed irradiance by shaded leaves per unit leaf area.

Attributes:

  • long_name: Absorbed irradiance by shaded leaves

  • units: W m\(^{-2}\)

  • detailed units: W (m\(^{2}\) leaf)\(^{-1}\)

  • type: array_like

  • shape: (n_z-1, n_wl)

  • dims: ['zm', 'wl']

aI_lsl#

Layerwise absorbed irradiance by sunlit leaves per unit leaf area.

Attributes:

  • long_name: Absorbed irradiance by sunlit leaves

  • units: W m\(^{-2}\)

  • detailed units: W (m\(^{2}\) leaf)\(^{-1}\)

  • type: array_like

  • shape: (n_z-1, n_wl)

  • dims: ['zm', 'wl']

aI_sh#

Layerwise absorbed irradiance by shaded leaves. Not per unit leaf area. Shaded leaves absorb only diffuse light.

Attributes:

  • long_name: Absorbed irradiance by shaded leaves

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_z-1, n_wl)

  • dims: ['zm', 'wl']

aI_sl#

Layerwise absorbed irradiance by sunlit leaves. Not per unit leaf area. Sunlit leaves absorb both direct and diffuse light.

Attributes:

  • long_name: Absorbed irradiance by sunlit leaves

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_z-1, n_wl)

  • dims: ['zm', 'wl']

clump#

Clump factor \(\Omega\). In (0, 1], this parameter represents the impact of leaf clumping in space on canopy light transmission and leaf absorption. It can vary with height in real canopies (like some of the other parameters here), but this is currently not supported.

Attributes:

  • long_name: Clump factor

  • units: 1

  • type: float

  • shape: ()

  • dims: ()

dlai#

LAI increment within layer (at midpoint levels).

Attributes:

  • long_name: Leaf area index in layer

  • units: m\(^{2}\) m\(^{-2}\)

  • detailed units: (m\(^{2}\) leaf) (m\(^{2}\) ground area)\(^{-1}\)

  • type: array_like

  • shape: (n_z-1,)

  • dims: ['zm']

dwl#

Wavelength band width.

Attributes:

  • long_name: Wavelength band width

  • units: μm

  • type: array_like

  • shape: (n_wl,)

  • dims: ['wl']

F#

Actinic flux (spherical) in wavebands.

Attributes:

  • long_name: Actinic flux (binned)

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_z, n_wl)

  • dims: ['z', 'wl']

f_slm#

Fraction of leaf area within mass layer that is sunlit.

Attributes:

  • long_name: Sunlit leaf fraction

  • units: 1

  • type: array_like

  • shape: (n_z-1,)

  • dims: ['zm']

G#

The value of the \(G\) function for the current solar zenith angle.

Attributes:

  • long_name: Fractional leaf area in the psi direction

  • units:

  • type: float

  • shape: ()

  • dims: ()

G_fn#

Function used to compute \(G\) from beam angle (\(G = G(\psi)\)). \(G = K_b \mu = K_b \cos{\psi}\). \(G\) is the ratio of leaf area projected in the \(\psi\) direction to actual leaf area. It is an average over all leaf inclination (and azimuthal) angles in the leaf angle distribution.

Attributes:

  • long_name: None

  • units:

  • type: function

  • shape: ()

  • dims: ()

I_d#

Downward irradiance (diffuse+direct) in wavebands.

Attributes:

  • long_name: Downward irradiance

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_z, n_wl)

  • dims: ['z', 'wl']

I_df0_all#

Incoming (downwelling) diffuse irradiance(s) at the top of the canopy.

Warning

Not spectral, energy flux density in discrete band.

Attributes:

  • long_name: Incoming diffuse irradiance at top-of-canopy

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_wl,)

  • dims: ['wl']

I_df_d#

Downward diffuse irradiance (hemispherical) in wavebands.

Attributes:

  • long_name: Downward diffuse irradiance (binned)

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_z, n_wl)

  • dims: ['z', 'wl']

I_df_u#

Upward diffuse irradiance (hemispherical) in wavebands.

Attributes:

  • long_name: Upward diffuse irradiance (binned)

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_z, n_wl)

  • dims: ['z', 'wl']

I_dr#

Direct irradiance in wavebands.

Attributes:

  • long_name: Direct beam irradiance (binned)

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_z, n_wl)

  • dims: ['z', 'wl']

I_dr0_all#

Incoming (downwelling) direct irradiance(s) at the top of the canopy.

Warning

Not spectral, energy flux density in discrete band.

Attributes:

  • long_name: Incoming direct irradiance at top-of-canopy

  • units: W m\(^{-2}\)

  • type: array_like

  • shape: (n_wl,)

  • dims: ['wl']

K_b#

\(K_b\) is the direct beam extinction coefficient.

Attributes:

  • long_name: Black leaf attenuation coefficient

  • units:

  • type: float

  • shape: ()

  • dims: ()

K_b_fn#

Function used to compute \(K_b\) from beam angle (\(K_b = K_b(\psi)\)). It depends on the leaf angle distribution (function) used, so it must be passed to the solvers.

Attributes:

  • long_name: None

  • units:

  • type: function

  • shape: ()

  • dims: ()

lad#

Leaf area density \(dlai/dz\).

Attributes:

  • long_name: Leaf area density

  • units: m\(^{2}\) m\(^{-3}\)

  • detailed units: (m\(^{2}\) leaf) (m\(^{2}\) ground area)\(^{-1}\) m\(^{-1}\)

  • type: array_like

  • shape: (n_z-1,)

  • dims: ['zm']

lai#

Leaf area index (LAI) profile, accumulated from the top (\(z=h_c\)).

Bottom to top:

  • lai[0]: total LAI

  • lai[-1] = 0 (canopy-atmos interface)

Attributes:

  • long_name: Leaf area index (cumulative)

  • units: m\(^{2}\) m\(^{-2}\)

  • detailed units: (m\(^{2}\) leaf) (m\(^{2}\) ground area)\(^{-1}\)

  • type: array_like

  • shape: (n_z,)

  • dims: ['z']

laim#

LAI at mass levels.

Attributes:

  • long_name: Leaf area index (cumulative)

  • units: m\(^{2}\) m\(^{-2}\)

  • detailed units: (m\(^{2}\) leaf) (m\(^{2}\) ground area)\(^{-1}\)

  • type: array_like

  • shape: (n_z-1,)

  • dims: ['zm']

leaf_r#

Leaf element reflectance.

Attributes:

  • long_name: Leaf reflectance

  • units: 1

  • type: array_like

  • shape: (n_wl,)

  • dims: ['wl']

leaf_t#

Leaf element transmittance.

Attributes:

  • long_name: Leaf transmittance

  • units: 1

  • type: array_like

  • shape: (n_wl,)

  • dims: ['wl']

mla#

Mean leaf (inclination) angle.

Attributes:

  • long_name: Mean leaf angle

  • units: deg

  • type: float

  • shape: ()

  • dims: ()

mu#

\(\cos(\psi)\).

Attributes:

  • long_name: cos(psi)

  • units:

  • type: float

  • shape: ()

  • dims: ()

psi#

\(\psi\) is the solar zenith angle (SZA).

Attributes:

  • long_name: Solar zenith angle

  • units: radians

  • type: float

  • shape: ()

  • dims: ()

soil_r#

Soil (ground surface) reflectivity.

Attributes:

  • long_name: None

  • units: 1

  • type: array_like

  • shape: (n_wl,)

  • dims: ['wl']

sza#

Solar zenith angle (SZA). \(\psi\) is the SZA in radians.

Attributes:

  • long_name: Solar zenith angle

  • units: deg

  • type: float

  • shape: ()

  • dims: ()

wl#

Wavelength (centers of the irradiance bins).

Attributes:

  • long_name: Wavelength

  • units: μm

  • type: array_like

  • shape: (n_wl,)

  • dims: ['wl']

wle#

Wavelengths of the irradiance band edges.

Attributes:

  • long_name: Wavelength of irradiance band edges

  • units: μm

  • type: array_like

  • shape: (n_wl+1,)

  • dims: ['wle']

z#

Height above ground for the interface levels (light fluxes).

Attributes:

  • long_name: Height above ground

  • units: m

  • type: array_like

  • shape: (n_z,)

  • dims: ['z']

zm#

Height above ground for the layer midpoints (mass levels).

Attributes:

  • long_name: Height above ground

  • units: m

  • type: array_like

  • shape: (n_z-1,)

  • dims: ['zm']