pyradtran.params.describe

Contents

pyradtran.params.describe#

pyradtran.params.describe(name: str, config=None, schema: Dict[str, Any] | None = None) → str[source]#

Return usage, help, and documentation for one uvspec option.

Parameters:

  • name (str) – The uvspec option name (e.g. "wc_modify").

  • config (SimulationConfig, optional) – Used to locate the local libRadtran install; package defaults when None.

  • schema (dict, optional) – Pre-loaded schema (mainly for tests).

Raises:

  • KeyError – If the option is unknown, with close-match suggestions.

  • RuntimeError – If no local libRadtran schema is available.

Contents