Command-line interface
This page documents the command line interface for duqtools.
To get started:
duqtools --help
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.
- init: Create a default config file.
- plot: Analyze the results and generate a report.
- 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 |
|---|---|---|---|
--dry-run |
boolean | Execute without any side-effects. | False |
-c, --config |
text | Path to config. | duqtools.yaml |
--debug |
boolean | Enable debug print statements. | False |
--out |
boolean | Remove output data. | False |
--help |
boolean | Show this message and exit. | False |
create
Create the UQ run files.
Usage:
duqtools create [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--dry-run |
boolean | Execute without any side-effects. | False |
-c, --config |
text | Path to config. | duqtools.yaml |
--debug |
boolean | Enable debug print statements. | False |
--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 |
|---|---|---|---|
--dry-run |
boolean | Execute without any side-effects. | False |
-c, --config |
text | Path to config. | duqtools.yaml |
--debug |
boolean | Enable debug print statements. | False |
--help |
boolean | Show this message and exit. | False |
init
Create a default config file.
Usage:
duqtools init [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--dry-run |
boolean | Execute without any side-effects. | False |
-c, --config |
text | Path to config. | duqtools.yaml |
--debug |
boolean | Enable debug print statements. | False |
--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 |
plot
Analyze the results and generate a report.
Usage:
duqtools plot [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--dry-run |
boolean | Execute without any side-effects. | False |
-c, --config |
text | Path to config. | duqtools.yaml |
--debug |
boolean | Enable debug print statements. | False |
--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 |
|---|---|---|---|
--dry-run |
boolean | Execute without any side-effects. | False |
-c, --config |
text | Path to config. | duqtools.yaml |
--debug |
boolean | Enable debug print statements. | False |
--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 |
|---|---|---|---|
--dry-run |
boolean | Execute without any side-effects. | False |
-c, --config |
text | Path to config. | duqtools.yaml |
--debug |
boolean | Enable debug print statements. | False |
--force |
boolean | Re-submit running jobs. | False |
--help |
boolean | Show this message and exit. | False |