bbp_workflow.simulation.util

Simulation utils.

Functions

campaign_sims(config[, include_empty])	Iterate simulations from the campaign.
read_config(config_dict[, coords_filter])	Read the simulation campaign configuration from dictionary and filter selected conditions.
xr_from_dict(array_dict)	Restore xarray from it's dict representation.
xr_to_dict(array)	Return dict representation of the xarray.

bbp_workflow.simulation.util.campaign_sims(config, include_empty=False)

Iterate simulations from the campaign.

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

Parameters:

• config (xarray.DataArray) – 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.

bbp_workflow.simulation.util.read_config(config_dict, coords_filter=None)

Read the simulation campaign configuration from dictionary and filter selected conditions.

Parameters:

• config_dict (dict) – Simulation campaign configuration as dictionary loaded from nexus or directly from config.json file.

• coords_filter (dict) – Optional subset of conditions selected for filtering.

Returns:

Simulation configuration with filter applied.

Return type:

xarray.DataArray

bbp_workflow.simulation.util.xr_from_dict(array_dict)

Restore xarray from it’s dict representation.

Parameters:

array_dict (dict) – Dictionary representation of the simulation configuration, probably loaded from json.

Returns:

Simulation configuration.

Return type:

xarray.DataArray

bbp_workflow.simulation.util.xr_to_dict(array)

Return dict representation of the xarray.