`cellpy.utils.batch_tools.batch_exporters`#

Module Contents#

Classes#

`CSVExporter`	Export experiment(s) to csv-files.
`ExcelExporter`	Exporter that saves the file in a format that Excel likes.
`OriginLabExporter`	Exporter that saves the files in a format convenient for OriginLab.

class CSVExporter(use_screen_dumper=False)[source]#

Bases: cellpy.utils.batch_tools.batch_core.BaseExporter

Inheritance diagram of cellpy.utils.batch_tools.batch_exporters.CSVExporter

Export experiment(s) to csv-files.

CSV Exporter looks at your experiments and exports data to csv format. It contains two engines: summary_engine and cycles_engine, and two dumpers: csv_dumper and screen_dumper.

You assign experiments to CSVExporter either as input during instantiation or by issuing the assign(experiment) method.

To perform the exporting, issue CSVExporter.do()

Example

>>> exporter = CSVExporter(my_experiment)
>>> exporter.do()

Parameters:: use_screen_dumper (bool) – dump info to screen (default False).

Setting up the Do-er.

Parameters:: *args – list of experiments

run_dumper(dumper)[source]#

run dumber (once pr. engine)

Parameters:: dumper – dumper to run (function or method).

The dumper takes the attributes experiments, farms, and barn as input.

run_engine(engine, **kwargs)[source]#

run engine (once pr. experiment).

Parameters:: engine – engine to run (function or method).

The method issues the engine command (with experiments and farms as input) that returns an updated farms as well as the barn and assigns them both to self.

The farms attribute is a list of farms, i.e. [farm1, farm2, …], where each farm contains pandas DataFrames.

The barns attribute is a pre-defined string used for picking what folder(s) the file(s) should be exported to. For example, if barn equals “batch_dir”, the file(s) will be saved to the experiments batch directory.

class ExcelExporter[source]#

Bases: cellpy.utils.batch_tools.batch_core.BaseExporter