Usage

The main form of interaction with duqtools is via the command-line interface. This page documents the different subcommands available .

To get started:

duqtools --help

For information on how to configure your UQ runs via duqtools.yaml, check out the configuration page.

duqtools

For more information, check out the documentation:

https://duqtools.readthedocs.io

Usage:

duqtools [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• clean: Delete generated IDS data and the run dir.
• create: Create the UQ run files.
• dash: Open dashboard for evaluating IDS data.
• go: Run create - submit - status - dash in succession, very useful for
• init: Create a default config file.
• merge: Merge data sets with error propagation.
• plot: Plot some IDS data.
• status: Print the status of the UQ runs.
• submit: Submit the UQ runs.

clean

Delete generated IDS data and the run dir.

Usage:

duqtools clean [OPTIONS]

Options:

Name	Type	Description	Default
--yes	boolean	Answer yes to questions automatically.	False
--dry-run	boolean	Execute without any side-effects.	False
-c, --config	text	Path to config.	duqtools.yaml
--debug	boolean	Enable debug print statements.	False
--logfile, -l	text	where to send the logfile, the special values stderr/stdout will send it there respectively.	duqtools.log
--out	boolean	Remove output data.	False
--force	boolean	Overwrite backup file if necessary.	False
--help	boolean	Show this message and exit.	False

create

Create the UQ run files.

Usage:

duqtools create [OPTIONS]

Options:

Name	Type	Description	Default
--yes	boolean	Answer yes to questions automatically.	False
--dry-run	boolean	Execute without any side-effects.	False
-c, --config	text	Path to config.	duqtools.yaml
--debug	boolean	Enable debug print statements.	False
--logfile, -l	text	where to send the logfile, the special values stderr/stdout will send it there respectively.	duqtools.log
--force	boolean	Overwrite existing run directories and IDS data.	False
--help	boolean	Show this message and exit.	False

dash

Open dashboard for evaluating IDS data.

Usage:

duqtools dash [OPTIONS]

Options:

Name	Type	Description	Default
--yes	boolean	Answer yes to questions automatically.	False
--dry-run	boolean	Execute without any side-effects.	False
-c, --config	text	Path to config.	duqtools.yaml
--debug	boolean	Enable debug print statements.	False
--logfile, -l	text	where to send the logfile, the special values stderr/stdout will send it there respectively.	duqtools.log
--help	boolean	Show this message and exit.	False

go

Run create - submit - status - dash in succession, very useful for existing tested and working pipelines

Usage:

duqtools go [OPTIONS]

Options:

Name	Type	Description	Default
--yes	boolean	Answer yes to questions automatically.	False
--dry-run	boolean	Execute without any side-effects.	False
-c, --config	text	Path to config.	duqtools.yaml
--debug	boolean	Enable debug print statements.	False
--logfile, -l	text	where to send the logfile, the special values stderr/stdout will send it there respectively.	duqtools.log
--force	boolean	Overwrite files when necessary.	False
--help	boolean	Show this message and exit.	False

init

Create a default config file.

Usage:

duqtools init [OPTIONS]

Options:

Name	Type	Description	Default
--yes	boolean	Answer yes to questions automatically.	False
--dry-run	boolean	Execute without any side-effects.	False
-c, --config	text	Path to config.	duqtools.yaml
--debug	boolean	Enable debug print statements.	False
--logfile, -l	text	where to send the logfile, the special values stderr/stdout will send it there respectively.	duqtools.log
--full	boolean	Create a config file with all possible config values.	False
--force	boolean	Overwrite existing config.	False
--help	boolean	Show this message and exit.	False

merge

Merge data sets with error propagation.

Usage:

duqtools merge [OPTIONS]

Options:

Name	Type	Description	Default
--yes	boolean	Answer yes to questions automatically.	False
--dry-run	boolean	Execute without any side-effects.	False
-c, --config	text	Path to config.	duqtools.yaml
--debug	boolean	Enable debug print statements.	False
--logfile, -l	text	where to send the logfile, the special values stderr/stdout will send it there respectively.	duqtools.log
--help	boolean	Show this message and exit.	False

plot

Plot some IDS data.

Usage:

duqtools plot [OPTIONS]

Options:

Name	Type	Description	Default
-x	text	IDS of the x value	None
-y	text	IDS of the y value	None
-m, --imas	text	IMAS path formatted as ///.	None
-i, --input	text	Input file, i.e. data.csv or runs.yaml	None
--yes	boolean	Answer yes to questions automatically.	False
--dry-run	boolean	Execute without any side-effects.	False
-c, --config	text	Path to config.	duqtools.yaml
--debug	boolean	Enable debug print statements.	False
--logfile, -l	text	where to send the logfile, the special values stderr/stdout will send it there respectively.	duqtools.log
--help	boolean	Show this message and exit.	False

status

Print the status of the UQ runs.

Usage:

duqtools status [OPTIONS]

Options:

Name	Type	Description	Default
--yes	boolean	Answer yes to questions automatically.	False
--dry-run	boolean	Execute without any side-effects.	False
-c, --config	text	Path to config.	duqtools.yaml
--debug	boolean	Enable debug print statements.	False
--logfile, -l	text	where to send the logfile, the special values stderr/stdout will send it there respectively.	duqtools.log
--detailed	boolean	Detailed info on progress	False
--progress	boolean	Fancy progress bar	False
--help	boolean	Show this message and exit.	False

submit

Submit the UQ runs.

Usage:

duqtools submit [OPTIONS]

Options:

Name	Type	Description	Default
--yes	boolean	Answer yes to questions automatically.	False
--dry-run	boolean	Execute without any side-effects.	False
-c, --config	text	Path to config.	duqtools.yaml
--debug	boolean	Enable debug print statements.	False
--logfile, -l	text	where to send the logfile, the special values stderr/stdout will send it there respectively.	duqtools.log
--force	boolean	Re-submit running jobs.	False
--help	boolean	Show this message and exit.	False