openpmd_api.DaskDataFrame Namespace Reference

Functions
	read_chunk_to_df (species, chunk, attributes=None)
	particles_to_daskdataframe (particle_species, attributes=None)

Detailed Description

This file is part of the openPMD-api.

Copyright 2021 openPMD contributors
Authors: Axel Huebl, Dmitry Ganyushin, John Kirkham
License: LGPLv3+

Function Documentation

particles_to_daskdataframe()

openpmd_api.DaskDataFrame.particles_to_daskdataframe	(		particle_species,
			attributes = None )

Load all records of a particle species into a Dask DataFrame.

Parameters
----------
particle_species : openpmd_api.ParticleSpecies
    A ParticleSpecies class in openPMD-api.
attributes : list of strings, optional
    A list of attributes of the particle_species that should be read and
    added as extra columns.

Returns
-------
dask.dataframe
    A dask dataframe with particles as index and openPMD record
    components of the particle_species as columns.

Raises
------
ImportError
    Raises an exception if dask or pandas are not installed

See Also
--------
openpmd_api.BaseRecordComponent.available_chunks : available chunks that
    are used internally to parallelize particle processing
dask.dataframe : the central dataframe object created here