xrdt

The main command to start the CLI provided by xrd-tools.

It provides a subset of commands for individual tasks to manage data related to XRD measurements.

xrdt [OPTIONS] COMMAND [ARGS]...

Options

--measurements-dir <measurements_dir>

Required Path to the measurements directory.

Default:

~/XRD_measurements

--version

Show the version and exit.

database

CLI to manage XRD measurements.

xrdt database [OPTIONS] COMMAND [ARGS]...

Options

--db-file <db_file>

Path to the database file (CSV).

Default:

/home/cschrein/.local/share/xrdt/measurements.csv

compare

Compare measurements registered in the DB.

xrdt database compare [OPTIONS]

compound

List measurements of certain compound registered in DB.

xrdt database compound [OPTIONS]

Options

--compound <compound>

Compound.

list

List DB file content.

xrdt database list [OPTIONS]

sample

List all measurements registered for a certain sample in the DB.

xrdt database sample [OPTIONS]

Options

--name <name>

ID of the sample.

device

CLI to manage measurement devices.

xrdt device [OPTIONS] COMMAND [ARGS]...

Options

--devices <devices>

Required Path to the device file (JSON).

Default:

~/.local/xrdt/devices.json

add

Create and register a new device.

xrdt device add [OPTIONS]

Options

--name <name>

Required Name of device to be added.

--device-type <device_type>

Device type.

Options:

X-ray diffractometer | High-temperature chamber

edit

Open the device file with an editor.

xrdt device edit [OPTIONS]

Options

--editor <editor>

Editor to be used.

Default:

nano

list

List all registered devices.

xrdt device list [OPTIONS]

remove

Remove a registered device.

xrdt device remove [OPTIONS]

Options

--name <name>

Name of device to be removed.

--force

Skip the confirmation prompt.

measurement

CLI to manage a XRD measurement.

xrdt measurement [OPTIONS] COMMAND [ARGS]...

add

Add a XRD measurement.

xrdt measurement add [OPTIONS]

Options

--measurement-id <measurement_id>

Required ID of the XRD measurement to add.

--preset <preset>

Preset to be assigned to the XRD measurement.

--source-file <source_file>

Path to the measurement source data file (ASCII).

--preset-file <preset_file>

Required Path to the preset file (JSON).

Default:

~/.local/xrdt/presets.json

--device-file <device_file>

Required Path to the device file (JSON).

Default:

~/.local/xrdt/devices.json

--ht-mode, --no-ht-mode

flag indicating if a high-tmeperature or ambient measurement is added, is redefined by preset if assigned.

Default:

False

--to-file, --no-file

flag indicating whether to write the XRD measurement to file(s).

Default:

True

--plot, --no-plot

flag to plot XRD data after addition.

Default:

True

--protocol

flag to create measurement protocol.

--zip-src, --no-zip-src

flag to indicate if archive with source data is added.

Default:

True

--rm-src, --no-rm-src

flag to indicate if source data file is deleted.

Default:

False

--force

flag to allow overwriting of existing files and skip confirmation prompts.

Default:

False

--author <author>

Name of the measurement protocol author, if it is created.

Default:

John Doe

--template-name <template_name>

Name of registered protocol template to be used if it is created.

--template_dir <template_dir>

Path to the template directory.

Default:

~/.local/xrdt/templates

plot

Plot a XRD measurement.

xrdt measurement plot [OPTIONS]

Options

--measurement-id <measurement_id>

ID of the XRD measurement to plot.

--norm

Plot the normalised XRD data.

protocol

(Create and) open a XRD measurement protocol.

xrdt measurement protocol [OPTIONS]

Options

--measurement-id <measurement_id>

ID of the XRD measurement.

--author <author>

Name of the author.

Default:

John Doe

--editor <editor>

Editor to be used.

Default:

nano

--template-name <template_name>

Name of registered measurement protocol template.

--template_dir <template_dir>

Path to the template directory.

Default:

~/.local/xrdt/templates

refine

Refine a XRD measurement with Profex.

This command requires a working installation of Profex on your computer.

xrdt measurement refine [OPTIONS]

Options

--measurement-id <measurement_id>

ID of the XRD measurement to refine.

--refiner <refiner>

Refinement interface plugin to be used.

Default:

profex

preset

CLI to manage measurement presets.

xrdt preset [OPTIONS] COMMAND [ARGS]...

Options

--presets <presets>

Required Path to the preset file (JSON).

Default:

~/.local/xrdt/presets.json

add

Create and register a new preset.

xrdt preset add [OPTIONS]

Options

--name <name>

Required Measurement preset name.

--devices <devices>

Required Path to the device file (JSON).

Default:

~/.local/xrdt/devices.json

edit

Open the preset file with an editor.

xrdt preset edit [OPTIONS]

Options

--editor <editor>

Editor to be used.

Default:

nano

list

List all registered presets.

xrdt preset list [OPTIONS]

remove

Remove a registered preset.

xrdt preset remove [OPTIONS]

Options

--name <name>

Name of preset to be removed.

--force

Omit confirmation prompt.

Default:

False

template

CLI to manage measurement document templates.

xrdt template [OPTIONS] COMMAND [ARGS]...

Options

--template_dir <template_dir>

Path to the template directory.

Default:

~/.local/xrdt/templates

add

Create and register a new document template.

xrdt template add [OPTIONS]

Options

--name <name>

Required Name of the template to be created.

--document-type <document_type>

Document type for the template to be created.

Options:

protocol

--editor <editor>

Editor to be used.

Default:

nano

--force

flag to allow overwriting of existing template file.

Default:

False

edit

Edit a registered measurement document template.

xrdt template edit [OPTIONS]

Options

--name <name>

Name of the template to be edited.

--editor <editor>

Editor to be used.

Default:

nano

list

List registered templates, optionally by type.

xrdt template list [OPTIONS]

Options

--document-type <document_type>

Document type for the template to be created.

Options:

protocol

remove

Remove a registered template.

xrdt template remove [OPTIONS]

Options

--name <name>

Name of the template to be removed.

--force

Skip the confirmation prompt.