crt1d

1-D canopy radiative transfer

Submodules

• crt1d.cases
• crt1d.data
• crt1d.diagnostics
• crt1d.leaf_angle
• crt1d.leaf_area
• crt1d.model
• crt1d.solvers
• crt1d.spectra
• crt1d.utils
• crt1d.variables

Classes

Model

A general class for testing 1-D canopy radiative transfer schemes.

Functions

print_config()

Print info about the schemes etc.

Package Contents

class crt1d.Model(scheme='2s', nlayers=60, **p_kwargs)

A general class for testing 1-D canopy radiative transfer schemes.

Create a model instance based on the default setup.

Parameters:

• scheme (str) – Identifier for the desired canopy radiative transfer scheme.

• psi (float) – Solar zenith angle (radians).

• nlayers (int) – Number of in-canopy layers to use in the solver (interface levels).

• **p_kwargs – Model parameter keyword arguments passed on to update_p().

assign_scheme(scheme_name, *, verbose=False)

Using the AVAILABLE_SCHEMES dict, assign scheme and necessary scheme attrs.

calc_absorption()

Calculate layerwise absorption variables.

copy_p()

Return a copy of the parameters dict.

plot_canopy()

Plot LAI and LAD profiles.

plot_leafsoil_spectra()

Plot the leaf and soil optical properties spectra used by the model.

plot_toc_spectra()

Plot the toc (top-of-canopy) irradiance spectra used for the upper boundary condition.

print_p()

Pretty print the parameters.

run(**extra_solver_kwargs)

TODO: could add verbose option

to_xr(*, info='')

Construct and return an xarray.Dataset.

Parameters:

info (str) – Extra information about the run/model to be stored in the dataset.

update_p(**kwargs)

Update parameters, if the validation passes.

Parameters:

**kwargs – Used to update the model parameters.

update_spectra(ds)

Update irradiance and leaf/soil optical property spectra from xarray.Dataset ds.

absorption = None

Absorption outputs calculated from the standard outputs out.

property cd

Canopy description.

out

Scheme standard outputs.

property out_all

Standard and extra outputs.

out_extra

Scheme extra outputs, such as absorption. Only some schemes provide any.

property p

Model parameters are indended to be read only (updated with update_p()). Invoking this just prints a message.

p_default

Default parameter settings dict.

required_input_keys

Required model inputs.

crt1d.print_config()

Print info about the schemes etc.