pogona.PlotterCSV

class pogona.PlotterCSV[source]

Bases: pogona.component.Component

Writes molecule positions to CSVs.

Attributes

component_name

Unique name of this component, unless it is "Generic component".

folder

Output folder for molecule positions relative to results_dir of the kernel.

write_interval

Allows skipping time steps if other than 1.

__init__()[source]

Methods

__init__()

finalize(simulation_kernel)

initialize(simulation_kernel, init_stage)

Use InitStages to initialize this Component instance.

process_new_time_step(simulation_kernel, ...)

set_arguments(**kwargs)

Read arguments as key value pairs and set this component's member variables accordingly.

__init__()[source]
finalize(simulation_kernel: pogona.simulation_kernel.SimulationKernel)
initialize(simulation_kernel: pogona.simulation_kernel.SimulationKernel, init_stage: pogona.component.InitStages)[source]

Use InitStages to initialize this Component instance.

process_new_time_step(simulation_kernel: pogona.simulation_kernel.SimulationKernel, notification_stage: pogona.component.NotificationStages)[source]
set_arguments(**kwargs)

Read arguments as key value pairs and set this component’s member variables accordingly. Validity of the argument values will be checked in initialize().

component_name = 'Generic component'

Unique name of this component, unless it is “Generic component”.

folder = ''

Output folder for molecule positions relative to results_dir of the kernel. A series of CSV files will be created here, one for each time step.

id

Unique integer component ID

write_interval = 1

Allows skipping time steps if other than 1. For example, writer_interval=3 will produce a CSV file in time step 0, then do nothing in time steps 1 and 2, then write again in time step 3.