blueetl.campaign.utils

Simulation campaign utils.

Originally based on: https://bbpgitlab.epfl.ch/nse/bbp-workflow/-/blob/2032ffd6/bbp_workflow/simulation/util.py

Functions

campaign_sims(config[, include_empty])

Iterate simulations from the campaign.

from_xarray(config)

Return a SimulationCampaign from xarray.DataArray or dict.
blueetl.campaign.utils.campaign_sims(config: dict | xarray.DataArray, include_empty: bool = False) → Iterator[tuple[dict[str, Any], str | None]]

Iterate simulations from the campaign.

Campaign sim can be empty if it was filtered out by coords_filter_func.

Parameters:

  • config (xarray.DataArray|dict) – Simulation campaign configuration.

  • include_empty (bool) – If true, all sims are included(even empty ones).

Yields:

tuple(dict, str) –

Simulation conditions and full path to individual simulation.

Path can be None if sim folder is empty.

blueetl.campaign.utils.from_xarray(config: dict | xarray.DataArray) → SimulationCampaign

Return a SimulationCampaign from xarray.DataArray or dict.