eradiate.scenes.biosphere.load_rami_scenario

eradiate.scenes.biosphere.load_rami_scenario(scenario_name, variant=RAMIScenarioVariant.ORIGINAL, padding=0, unpack_folder=None, spectral_data=None)[source]

Load a scenario based on its name and variant.

This function will check if scenario data can be found at the target location; if not, it will download them automatically.

Parameters:

  • scenario_name (str or RAMIActualCanopies or RAMIHeterogeneousAbstractCanopies or RAMIHomogeneousAbstractCanopies) – The name of the RAMI-V scenario. If a string is provided, it will automatically be converted to the appropriate enum.

  • variant (RAMIScenarioVariant) – The variant of the scenario.

  • padding (int, optional) – The padding to apply to the scenario, defaults to 0.

  • unpack_folder (path-like, optional) – Directory where scenario data is expected to be stored — and where downloaded data will be unpacked. Defaults to $PWD.

  • spectral_data (dict[str, Any or dict[str, Any]] or None) – Spectral data to apply to the scenario, defaults to None (keep original).

Returns:

dict – The scenario.

See also

load_scenario