eradiate.scenes.biosphere.load_rami_scenario#
- eradiate.scenes.biosphere.load_rami_scenario(scenario_name, version=RAMIScenarioVersion.ORIGINAL, padding=0, unpack_folder=None)[source]#
Load a scenario based on its name and version.
- Parameters:
scenario_name (
strorRAMIActualCanopiesorRAMIHeterogeneousAbstractCanopiesorRAMIHomogeneousAbstractCanopies) – The name of the RAMI-V scenario. If a string is provided, it will automatically be converted to the appropriate enum.version (
RAMIScenarioVersion) – The version of the scenario.padding (
int, optional) – The padding to apply to the scenario, defaults to 0.unpack_folder (
Path, optional) – The folder to unpack the scenario to, defaults to None (current working directory).
- Returns:
dict– The scenario.