openpmd_api.DaskArray Namespace Reference

Classes
class	DaskRecordComponent

Functions
def	record_component_to_daskarray (record_component)

Variables
bool	found_dask = True

Detailed Description

This file is part of the openPMD-api.

Copyright 2021 openPMD contributors
Authors: Axel Huebl
License: LGPLv3+

Function Documentation

record_component_to_daskarray()

def openpmd_api.DaskArray.record_component_to_daskarray

(

record_component

)

Load a RecordComponent into a Dask.array.

Parameters
----------
record_component : openpmd_api.Record_Component
    A record component class in openPMD-api.

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