xbout.adioswriter.write_dataset_bp

xbout.adioswriter.write_dataset_bp(ds, path, *, time_dim='t', engine='BP4', parameters=None, overwrite=True, variables=None, write_ints_as_int32=False)[source]

Write an xarray Dataset to an ADIOS2 .bp output.

Return type:

None

Parameters:

  • path (str)

  • time_dim (str)

  • engine (str)

  • parameters (Mapping[str, str] | None)

  • overwrite (bool)

  • variables (Iterable[str] | None)

  • write_ints_as_int32 (bool)

Design choices: - Map time_dim to ADIOS2 steps (variables containing time_dim are written

one slice per step).

  • Store per-variable dimension names as attribute {var}/__xarray_dimensions__ excluding time_dim when writing steps.

  • Store dataset attributes under __xarray_dataset_attrs__/{key}.

  • Optionally store all integer variables as int32 on disk (see write_ints_as_int32), while preserving the original dtype via the __xarray_original_dtype__ attribute for round-tripping.