Ctrl+K

cellpy.utils.batch_tools.engines

cellpy.utils.batch_tools.engines#

Engines are functions that are used by the Do-ers.

Keyword Args: experiments, farms, barn, optionals Returns: farms, barn

Module Contents#

Functions#

cycles_engine(**kwargs)

engine to extract cycles

dq_dv_engine(**kwargs)

engine that performs incremental analysis of the cycle-data

raw_data_engine(**kwargs)

engine to extract raw data

simple_db_engine([reader, cell_ids, file_list, ...])

Engine that gets values from the db for given set of cell IDs.

sql_db_engine(→ pandas.DataFrame)

summary_engine(**kwargs)

engine to extract summary data

Attributes#

SELECTED_SUMMARIES

hdr_journal

hdr_summary

cycles_engine(**kwargs)[source]#

engine to extract cycles

dq_dv_engine(**kwargs)[source]#

engine that performs incremental analysis of the cycle-data

raw_data_engine(**kwargs)[source]#

engine to extract raw data

simple_db_engine(reader=None, cell_ids=None, file_list=None, pre_path=None, include_key=False, include_individual_arguments=True, additional_column_names=None, batch_name=None, **kwargs)[source]#

Engine that gets values from the db for given set of cell IDs.

The simple_db_engine looks up values for mass, names, etc. from the db using the reader object. In addition, it searches for the corresponding raw files / data.

Parameters:

  • reader – a reader object (defaults to dbreader.Reader)

  • cell_ids – keys (cell IDs) (assumes that the db has already been filtered, if not, use batch_name).

  • file_list – file list to send to filefinder (instead of searching in folders for files).

  • pre_path – prepended path to send to filefinder.

  • include_key – include the key col in the pages (the cell IDs).

  • include_individual_arguments – include the argument column in the pages.

  • additional_column_names – list of additional column names to include in the pages.

  • batch_name – name of the batch (used if cell_ids are not given)

  • **kwargs – sent to filefinder

Returns:

pages (pandas.DataFrame)

sql_db_engine(*args, **kwargs) → pandas.DataFrame[source]#
summary_engine(**kwargs)[source]#

engine to extract summary data

SELECTED_SUMMARIES[source]#
hdr_journal[source]#
hdr_summary[source]#
Contents