Commandline Reference¶

OBR init¶

Usage¶

Usage: obr init [OPTIONS]

Options:
  -f, --folder TEXT      Where to create the workspace and view
  -e, --execute BOOLEAN
  -c, --config TEXT      Path to configuration file.
  -t, --tasks INTEGER    Number of tasks to run concurrently.
  -u, --url TEXT         Url to a configuration yaml
  --verbose INTEGER      set verbosity
  --help                 Show this message and exit.

Make sure to have openfoam sourced.

OBR query¶

Usage¶

Usage: obr query [OPTIONS]

Options:
  -f, --folder TEXT
  --filter TEXT      Pass a <key><predicate><value> value pair per occurrence
                     of --filter. Predicates include ==, !=, <=, <, >=, >. For
                     instance, obr query --filtersolver==pisoFoam
  -d, --detailed
  -a, --all
  -q, --query TEXT   Pass a <key><predicate><value> value pair per occurrence
                     of --query. Predicates include ==, !=, <=, <, >=, >. For
                     instance, obr query --query solver==pisoFoam  [required]
  -v, --verbose      Set for additional output.
  --help             Show this message and exit.

Understanding OBR query¶

obr query recursively traverses the current directory, or the directory specified by the --folder argument, for signac_statepoint.json files.

Common Problems¶

obr query -q [Query] does not return anything.
- As of now, obr query ignores jobs that do not include the obr key in their corresponding signac_job_document.json file.
- The obr key is only added to the signac_job_document.json file after running this job at least once.
- For instance, after initializing an OBR workspace via obr init and running a valid query, nothing is returned. After successfully running obr run, the aforetried query should return the expected result.

OBR run¶

Usage¶

Usage: obr run [OPTIONS]

  Run specified operations

Options:
  -f, --folder TEXT
  -o, --operations TEXT  Specify the operation(s) to run. Pass multiple
                         operations after -o, separated by commata (NO space),
                         e.g. obr run -o shell,apply. Run with --help to list
                         available operations.  [required]
  -l, --list-operations  Prints all available operations and returns.
  --filter TEXT          Pass a <key><predicate><value> value pair per
                         occurrence of --filter. Predicates include ==, !=,
                         <=, <, >=, >. For instance, obr run -o
                         runParallelSolver --filter "solver==pisoFoam"
  -j, --job TEXT
  --args TEXT
  -t, --tasks INTEGER
  -a, --aggregate
  --args TEXT
  --help                 Show this message and exit.

Understanding obr run¶

A set of operations can be passed after the -o flag.

Example: obr run -o fetchCase,runParallelSolver

It is important to note, that there can be no whitespace in between. Otherwise, the runParallelSolver will be parsed as separate commandline argument.

To list all available operations, run obr run --list-operations, obr run [--operations|-o] --help or obr operations.

OBR status¶

Usage¶

Usage: obr status [OPTIONS]

Options:
  -f, --folder TEXT
  -d, --detailed
  --help             Show this message and exit.

OBR submit¶

Usage¶

Usage: obr submit [OPTIONS]

Options:
  -f, --folder TEXT
  -p, --pretend          Set flag to only print submission script
  -o, --operations TEXT  Specify the operation(s) to run. Pass multiple
                         operations after -o, separated by commata (NO space),
                         e.g. obr run -o shell,apply. Run with --help to list
                         available operations.  [required]
  -l, --list-operations  Prints all available operations and returns.
  --filter TEXT          Pass a <key><predicate><value> value pair per
                         occurrence of --filter. Predicates include ==, !=,
                         <=, <, >=, >. For instance, obr submit --filter
                         "solver==pisoFoam"
  --bundling_key TEXT
  -p, --partition TEXT
  --account TEXT
  --pretend
  --scheduler_args TEXT  Currently required to be in --key1 value --key2
                         value2 form
  --help                 Show this message and exit.

OBR operations¶

obr operations lists all available operations inside a given OpenFOAMProject.

Usage¶

Usage: obr operations [OPTIONS]

Options:
  -f, --folder TEXT
  --help             Show this message and exit.