Command Line Interface#

bdat#

bdat [OPTIONS] COMMAND [ARGS]...

Options

-c, --config <config>#: Path to a config file

--debug#: Print debug information and raise exceptions

aging-data#

group cell life data into aging data

bdat aging-data [OPTIONS] [CELLLIFE_ID]...

Options

-t, --target <target_id>#

--title <title>#: Required

--replace#: Replace existing documents

--testmatrix <testmatrix>#

Arguments

CELLLIFE_ID#: Optional argument(s)

battery-patterns#

Detect patterns in all tests of a battery

bdat battery-patterns [OPTIONS] [BATTERY_ID]...

Options

-t, --target <target_id>#: Collection to store the results

-p, --parallel <parallel>#: Number of parallel worker processes

--debug#: Raise any exceptions that occur during the evaluation

--type <patterntype>#: Only search for the specified type of pattern

--replace#: Overwrite previous results if they already exist

--ignore-test <ignore_test>#: Tests to ignore when looking for previous tests

--skip-missing-steplists#: Ignore tests that have no test steps

Arguments

BATTERY_ID#: Optional argument(s)

cell-life#

collect data about cell aging

bdat cell-life [OPTIONS] [SPECIMEN_ID]...

Options

-t, --target <target_id>#

--debug#: Raise any exceptions that occur during the evaluation

-p, --parallel <parallel>#: number of parallel worker processes

--replace#: Replace existing documents

--testmatrix <testmatrix>#

Arguments

SPECIMEN_ID#: Optional argument(s)

columns#

Print test columns

bdat columns [OPTIONS] RESOURCE_ID

Arguments

RESOURCE_ID#: Required argument

copy#

Copy resource to other collection

bdat copy [OPTIONS] [RESOURCE_ID]...

Options

-t, --target <target_id>#: Required Target collection id

Arguments

RESOURCE_ID#: Optional argument(s)

delete#

Delete resource from database

bdat delete [OPTIONS] [RESOURCE_ID]...

Options

--data <data>#: Field name that stores a reference to a file that should also be deleted

Arguments

RESOURCE_ID#: Optional argument(s)

diff-query#

print list of entities that get returned by query A but not by query B

bdat diff-query [OPTIONS] QUERY_A QUERY_B

Options

-c, --collection <collection>#: Required

Arguments

QUERY_A#: Required argument

QUERY_B#: Required argument

download#

Save resources to local files

bdat download [OPTIONS] [RESOURCE_ID]...

Options

-t, --target <target_folder>#: Required Folder that the data will be stored in

Arguments

RESOURCE_ID#: Optional argument(s)

download-data#

Save test data to local files

bdat download-data [OPTIONS] [TEST_ID]...

Options

-t, --target <target_folder>#: Required Folder that the data will be stored in

--filename <filename_pattern>#: Format string that is used to create filenames for the data files. Available replacements are {id}, {test}, {specimen}, {parent}, {root}, {ext}, and {startdate}.

--include-running#: Include tests that are still running

--delete-running#: Delete previously downloaded data files for tests that are still running

--overwrite#: Overwrite existing files

Arguments

TEST_ID#: Optional argument(s)

download-plotdata#

Save plot data to local files

bdat download-plotdata [OPTIONS] [PLOT_ID]...

Options

--filename <filename_pattern>#: Format string that determines the names of the files that are created

--columns <columnlist>#: Comma-separated list of columns to download

--sort <sort>#: Sort data by the specified column

--dataset <dataset>#: Required Name of the dataset to download

--filter <filter>#: Filter data that is downloaded

--format <format>#: Format of the data files. Can be csv or parquet.

Arguments

PLOT_ID#: Optional argument(s)

evalgroup#

Group testevals based on given criteria

bdat evalgroup [OPTIONS] [RES_ID]...

Options

-t, --target <target_id>#: Collection to store the results

-c, --collection <collection_id>#: Collection that contains the testeval resources

--testset <testset_id>#: Filter resources by testset

--project <project_id>#: Filter resources by project

--species <species_id>#: Filter resources by species

--specimen <specimen_id>#: Filter resources by specimen

--test <test_id>#: Filter resources by test

--type <evaltype>#: Only include resources that contain an evaluation of this type

--unique <unique>#: Can be ‘first’ or ‘last’. Keep only first/last testeval with the same properties specified by –unique-link and –unique-key

--unique-link <unique_link>#: Linked entity that is used to find unique evals

--unique-key <unique_key>#: Testeval attribute that is used to find unique evals

--filter <filter>#: Eval attribute that is used to filter the results

--exclude-tests <exclude_tests>#: Resource ids of tests that should be excluded

--replace#: Overwrite previous results if they already exist

--before <before>#: Only include testevals for tests before this date

--after <after>#: Only include testevals for tests after this date

--title <title>#: Title for the created resource

Arguments

RES_ID#: Optional argument(s)

exists#

Filter resource ids and return only those that exist

bdat exists [OPTIONS] [RESOURCE_ID]...

Options

-n, --invert#: Invert filter to keep ids that do not exist

--ref-field, --rf <ref_field>#: Field to search for the resource id instead of the document id. Must be used together with –collection.

-c, --collection <collection_id>#: Collection to search for matching documents. Must be used together with –ref-field.

--print-referencing-doc, --prd#: Print the id of the document containing the reference instead of the reference id. Must be used together with –ref-field.

Arguments

RESOURCE_ID#: Optional argument(s)

import-fittingdata#

Import aging data from a fittingdata JSON export

bdat import-fittingdata [OPTIONS] [FILE]...

Options

-t, --target <target_id>#: Required Collection to store the results

-p, --project <project>#: Required Project that the results will be linked to

--species <species>#: Required Species that the created cells will be linked to

--cellname-filter <cellname_filter>#: Only import data for cells with names that match the given regex

--replace#: Overwrite previous results if they already exist

--list-cells#: Only list all cellnames from the data files instead of importing anything

--doi <doi>#: DOI of a publication linked to the given data

--cellname-suffix <cellname_suffix>#: Suffix to add to the names of created cells

Arguments

FILE#: Optional argument(s)

import-testmatrix#

import testmatrix from excel file

bdat import-testmatrix [OPTIONS] FILE

Options

--title <title>#: Required

-p, --project <project>#: Required

-b, --battery <battery>#: Required

--charge-current <charge_current>#

--discharge-current <discharge_current>#

--discharge-power <discharge_power>#

--min-voltage <min_voltage>#

--max-voltage <max_voltage>#

--mean-voltage <mean_voltage>#

--min-soc <min_soc>#

--max-soc <max_soc>#

--mean-soc <mean_soc>#

--dod <dod>#

--temperature <temperature>#

--upper-pause-duration <upper_pause_duration>#

--lower-pause-duration <lower_pause_duration>#

--charge-crate <charge_cRate>#

--discharge-crate <discharge_cRate>#

--sheet <sheet>#

-t, --target <target>#: Required

--replace#

Arguments

FILE#: Required argument

import-tests#

Import tests from data files

bdat import-tests [OPTIONS] METADATA

Options

-p, --project <project>#: Required

--set <set>#: Required

--circuit <circuit>#: Required

--species <species>#: Required

--actor <actor>#: Required

--filename <filename>#: Required

--cell-column <cell_column>#: Required

--start-column <start_column>#: Required

--end-column <end_column>#: Required

--info-column <info_column>#

--time-format <time_format>#

-t, --target <target>#: Required

Arguments

METADATA#: Required argument

list#

List all entities in a collection

bdat list [OPTIONS] [REF_ID]...

Options

-c, --collection <collection_id>#: Required Collection to search for matching documents. Must be used together with –ref-field.

--ref-field, --rf <ref_field>#: Filter by linked resource. Must be used together with ref_id

Arguments

REF_ID#: Optional argument(s)

list-links#

List all entities linked to by another entity

bdat list-links [OPTIONS] [RES_ID]...

Options

--ref-field, --rf <ref_field>#: Required Filter by link name

Arguments

RES_ID#: Optional argument(s)

patterns#

Detect patterns in test steps

bdat patterns [OPTIONS] [STEPLIST_ID]...

Options

-t, --target <target_id>#: Collection to store the results

-p, --parallel <parallel>#: Number of parallel worker processes

--debug#: Raise any exceptions that occur during the evaluation

--type <patterntype>#: Only search for the specified type of pattern

--replace#: Overwrite previous results if they already exist

--ignore-test <ignore_test>#: Tests to ignore when looking for previous tests

Arguments

STEPLIST_ID#: Optional argument(s)

plot#

Create plots for resources

bdat plot [OPTIONS] [RESOURCE_ID]...

Options

-t, --target <target_id>#: Collection to store the results

--to-parquet <to_parquet>#: Save plotted data to a parquet file

--type <plot_type>#: Required Type of plot to create

-p, --parallel <parallel>#: Number of parallel worker processes

--debug#: Raise any exceptions that occur during the evaluation

--replace#: Overwrite previous results if they already exist

Arguments

RESOURCE_ID#: Optional argument(s)

query#

query records

bdat query [OPTIONS] QUERY

Options

-c, --collection <collection>#: Required

--json#

--id-only#

Arguments

QUERY#: Required argument

server#

Launch a web server to view plots from the database

bdat server [OPTIONS]

Options

-p, --port <port>#: Port to listen on

-h, --host <host>#: Host to bind to

show#

Print resource

bdat show [OPTIONS] [RESOURCE_ID]...

Options

--attr <attr>#: Attribute to print instead of the whole resource

Arguments

RESOURCE_ID#: Optional argument(s)

show-testsets#

Show an overview of testsets in the database

bdat show-testsets [OPTIONS] COLLECTION_ID

Arguments

COLLECTION_ID#: Required argument

steps#

Detect steps in test data

bdat steps [OPTIONS] [TEST_ID]...

Options

-t, --target <target_id>#: Collection to store the results

--debug#: Raise any exceptions that occur during the evaluation

-p, --parallel <parallel>#: Number of parallel worker processes

--replace#: Overwrite previous results if they already exist

Arguments

TEST_ID#: Optional argument(s)

testgroup#

Group tests based on given criteria

bdat testgroup [OPTIONS] [RES_ID]...

Options

-t, --target <target_id>#: Collection to store the results

-c, --collection <collection_id>#: Collection that contains the tests

--testset <testset_id>#: Filter resources by testset

--project <project_id>#: Filter resources by project

--species <species_id>#: Filter resources by species

--specimen <specimen_id>#: Filter resources by specimen

--test <test_id>#: Filter resources by test

--type <evaltype>#

--unique <unique>#: Can be ‘first’ or ‘last’. Keep only first/last test with the same properties specified by –unique-link and –unique-key

--unique-link <unique_link>#: Linked entity that is used to find unique tests

--unique-key <unique_key>#: Testeval attribute that is used to find unique tests

--filter <filter>#: Test attribute that is used to filter the results

--exclude-tests <exclude_tests>#: Resource ids of tests that should be excluded

--replace#: Overwrite previous results if they already exist

--before <before>#: Only include testevals for tests before this date

--after <after>#: Only include testevals for tests after this date

--title <title>#: Title for the created resource

Arguments

RES_ID#: Optional argument(s)

testlist#

List all tests in a testset

bdat testlist [OPTIONS] [TESTSET_ID]...

Options

-c, --collection <test_collection>#: Required Collection containing the tests

--ordered#: Order tests by start date

Arguments

TESTSET_ID#: Optional argument(s)

update#

Update resource

bdat update [OPTIONS] [RESOURCE_ID]...

Options

-p, --parallel <parallel>#: Number of parallel worker processes

--debug#: Raise any exceptions that occur during the evaluation

Arguments

RESOURCE_ID#: Optional argument(s)

version#

Print version and exit

bdat version [OPTIONS]