openPMD-api
|
Classes | |
class | DaskRecordComponent |
Functions | |
def | record_component_to_daskarray (record_component, chunks=None) |
This file is part of the openPMD-api. Copyright 2021-2023 openPMD contributors Authors: Axel Huebl, Pawel Ordyna License: LGPLv3+
def openpmd_api.DaskArray.record_component_to_daskarray | ( | record_component, | |
chunks = None |
|||
) |
Load a RecordComponent into a Dask.array. Parameters ---------- record_component : openpmd_api.Record_Component A record component class in openPMD-api. chunks : chunks parameter to pass to dask.array.from_array. See dask documentation for more details. When set to None (default) the chunking will be automaticaly determined based on record_component.available_chunks(). Returns ------- dask.array A dask array. Raises ------ ImportError Raises an exception if dask is not installed See Also -------- openpmd_api.BaseRecordComponent.available_chunks : available chunks that are used internally to parallelize reading dask.array : the (potentially distributed) array object created here