cellpy.utils.example_data

`cellpy.utils.example_data`#

Tools for getting some data to play with

Module Contents#

Classes#

ExampleData

Enum for example data files

Functions#

`arbin_file_path`(→ pathlib.Path)	Get the path to an example arbin res file
`arbin_multi_file_path`(→ pathlib.Path)	Get the path to an example arbin res file
`biologics_file_path`(→ pathlib.Path)	Get the path to an example biologics mpr file
`cellpy_file`(→ cellpy.cellreader.CellpyCell)	load an example cellpy file.
`cellpy_file_path`(→ pathlib.Path)	Get the path to an example cellpy file
`custom_file_path`(→ pathlib.Path)	Get the path to an example custom data csv file
`custom_instrument_path`(→ pathlib.Path)	Get the path to an example custom instrument definition yaml file
`custom_xlsx_file_path`(→ pathlib.Path)	Get the path to an example custom data Excel file
`download_all_files`()	Download all example data files from the cellpy-data repository.
`download_file`(url, local_filename)	Download a file from the web.
`local_instrument_path`(→ pathlib.Path)	Get the path to an example local-instrument definition yaml file
`maccor_file_path`(→ pathlib.Path)	Get the path to an example maccor txt file
`maccor_file_path_type_one`(→ pathlib.Path)	Get the path to an example maccor txt file
`maccor_file_path_type_three`(→ pathlib.Path)	Get the path to an example maccor txt file
`maccor_file_path_type_two`(→ pathlib.Path)	Get the path to an example maccor txt file
`neware_file_path`(→ pathlib.Path)	Get the path to an example neware csv file
`old_cellpy_file_path`(→ pathlib.Path)	Get the path to an example cellpy file
`pec_file_path`(→ pathlib.Path)	Get the path to an example pec csv file
`rate_file`()	Get the path to an example cellpy file with rate data
`raw_file`(→ cellpy.cellreader.CellpyCell)	load an example data file (arbin).

Attributes#

`CHUNK_SIZE`
`CURRENT_PATH`
`DATA_PATH`
`DO_NOT_REMOVE_THESE_FILES`

class ExampleData(*args, **kwds)[source]#

Bases: enum.Enum

Inheritance diagram of cellpy.utils.example_data.ExampleData

Enum for example data files

ARBIN = '20160805_test001_45_cc_01.res'[source]#

AUX_MULTI_X = 'aux_multi_x.res'[source]#

CELLPY = '20180418_sf033_4_cc.h5'[source]#

CUSTOM = 'custom_data.csv'[source]#

CUSTOM_EXCEL = 'custom_data.xlsx'[source]#

CUSTOM_INSTRUMENT = 'custom_instrument.yml'[source]#

LOCAL_INSTRUMENT = 'local_instrument.yml'[source]#

MACCOR_TXT_TYPE_ONE = 'maccor_one.txt'[source]#

MACCOR_TXT_TYPE_THREE = 'maccor_three.txt'[source]#

MACCOR_TXT_TYPE_TWO = 'maccor_two.txt'[source]#

NEWARE_CSV = 'neware_uio.csv'[source]#

OLD_CELLPY = '20160805_test001_45_cc.h5'[source]#

PEC_CSV = 'pec.csv'[source]#

RATE = '20231115_rate_cc.h5'[source]#

arbin_file_path() → pathlib.Path[source]#: Get the path to an example arbin res file

arbin_multi_file_path() → pathlib.Path[source]#: Get the path to an example arbin res file

biologics_file_path() → pathlib.Path[source]#: Get the path to an example biologics mpr file

cellpy_file(testing: bool = False) → cellpy.cellreader.CellpyCell[source]#

load an example cellpy file.

Parameters:: testing (bool) – run in test mode
Returns:: cellpy.CellpyCell object with the data loaded

cellpy_file_path() → pathlib.Path[source]#: Get the path to an example cellpy file

custom_file_path() → pathlib.Path[source]#: Get the path to an example custom data csv file

custom_instrument_path() → pathlib.Path[source]#: Get the path to an example custom instrument definition yaml file

custom_xlsx_file_path() → pathlib.Path[source]#: Get the path to an example custom data Excel file

download_all_files()[source]#: Download all example data files from the cellpy-data repository.

download_file(url, local_filename)[source]#

Download a file from the web.

Parameters:

url (str) – URL of the file to download
local_filename (str) – Local filename to save the file to

local_instrument_path() → pathlib.Path[source]#: Get the path to an example local-instrument definition yaml file for loading csv-type files

maccor_file_path() → pathlib.Path[source]#: Get the path to an example maccor txt file

maccor_file_path_type_one() → pathlib.Path[source]#: Get the path to an example maccor txt file

maccor_file_path_type_three() → pathlib.Path[source]#: Get the path to an example maccor txt file

maccor_file_path_type_two() → pathlib.Path[source]#: Get the path to an example maccor txt file

neware_file_path() → pathlib.Path[source]#: Get the path to an example neware csv file

old_cellpy_file_path() → pathlib.Path[source]#: Get the path to an example cellpy file

pec_file_path() → pathlib.Path[source]#: Get the path to an example pec csv file

rate_file()[source]#: Get the path to an example cellpy file with rate data

raw_file(auto_summary: bool = True, testing: bool = False) → cellpy.cellreader.CellpyCell[source]#

load an example data file (arbin).

Parameters:

auto_summary (bool) – run make_summary automatically (defaults to True)
testing (bool) – run in test mode

Returns:

cellpy.CellpyCell object with the data loaded

CHUNK_SIZE = 8192[source]#

CURRENT_PATH[source]#

DATA_PATH[source]#

DO_NOT_REMOVE_THESE_FILES = ['.gitkeep'][source]#