picongpu.pypicongpu.output

Submodules

Package Contents

Classes

Auto

Class to provide output without further configuration.
class picongpu.pypicongpu.output.Auto

Bases: picongpu.pypicongpu.rendering.RenderedObject

Inheritance diagram of picongpu.pypicongpu.output.Auto

Class to provide output without further configuration.

This class requires a period (in time steps) and will enable as many output plugins as feasable for all species. Note: The list of species from the initmanager is used during rendering.

No further configuration is possible! If you want to provide additional configuration for plugins, create a separate class.

period

period to print data at

check() → None

validate attributes

if ok pass silently, otherwise raises error

Raises:

  • ValueError – period is non-negative integer

  • ValueError – species_names contains empty string

  • ValueError – species_names contains non-unique name

get_rendering_context() → dict

get rendering context representation of this object

delegates work to _get_serialized and invokes checks performed by check_context_for_type(). :raise ValidationError: on schema violiation :raise RuntimeError: on schema not found :return: self as rendering context

static check_context_for_type(type_to_check: type, context: dict) → None

check if the given context is valid for the given type

Raises on error, passes silently if okay.

Raises:

  • ValidationError – on schema violiation

  • RuntimeError – on schema not found