IDS manual
ids <subcommand> [options]
Subcommands:
To get further help and a list of available options for any subcommand run:
ids <subcommand> --help
Subcommands and options
Each subcommand has its own set of options. Use ids <subcommand> --help to
see which of the following options apply to any of the subcommands listed
above.
init
- rundir
Name of the IDS run directory structure. Must be given.
- --force
If given, a previously existing IDS run directory structure with the same name will be overwritten (including data and configuration files).
go
- config
Path to the IDS config file which defines the inversion parameters. Must be given.
- --force
If given, a previously existing run with the same name will be overwritten.
harvest
- rundir
Path to the run directory, for which results shall be harvested. Must be given.
- --force
If given, any previously harvested results are overwritten.
report
- rundir
Path to the run directory, for which report plots shall be generated. Must be given.
- --nparallel
Number of processes run in parallel. 0 allows for using all cores.
Command line examples
Initialize an IDS environment
Initialize a new IDS runing folder called ids_directory.
ids init ids_directory
The option --force will clear any previous IDS environment with the same
name and initialize a new clear one.
Run an IDS estimate
Run the optimization for the given event using a configuration file stored in config/idsconfig_example.conf.
ids go config/idsconfig_example.conf
The option --force will clear any previous IDS run with the same run name as defined in the configuration file.
Create an IDS report
Generate plots of the results of a run called run/ids_testrun.
ids report run/ids_testrun/
The option --force will clear any previous IDS run with the same run name as defined in the configuration file.