CLI

The cli module implements a command line interface that allows to interact with Curveball through a command line or terminal, without any knowledge in Python programming.

The Tutorial includes a complete walkthrough on using the CLI to analyse growth cruves data.

Members

curveball.scripts.cli.find_plate_file(plate_folder, plate_file)[source]

Finds a plate file, either in the current working dir or in the package data resources.

Parameters
plate_filestr

the filename of the plate file, may include absolute or relative path

Returns
str

the full path of the plate file.

curveball.scripts.cli.get_filename(filepath)[source]

Get a file name out of a file path.

Parameters
filepathstr
Returns
str

filename

curveball.scripts.cli.load_plate(plate_path)[source]

Loads a plate template from a CSV file.

Parameters
plate_pathstr

full or relative path to the plate template file.

Returns
pandas.DataFrame

the plate template in tidy data format (see ioutils).

See also

find_plate_file
curveball.scripts.cli.where(ctx, param, value)[source]

Prints the path where Curveball is installed and exits.

Parameters are generally ignored; if value or ctx.resilient_parsing are not empty/False/None, the function returns without doing anything.