Rombus API
Rombus provides a CLI interface through which most common Rombus tasks can be accomplished.
rombus
Build and work with Reduced Order Models (ROMs) with Rombus.
Please see the Rombus documentation at https://rombus.readthedocs.io for information about how to work with Rombus.
N.B.: The commands listed below are roughly in the order that most users will need to use them.
rombus [OPTIONS] COMMAND [ARGS]...
build
Build a Reduced Order Model.
rombus build [OPTIONS] MODEL FILENAME_SAMPLES
Options
- -o, --out <out>
Output HDF5 filename
- Default:
MODEL_BASENAME.hdf5
- --do_step <do_step>
Do only one step: RB=reduced basis; EI=empirical interpolant
- Options:
RB | EI
Arguments
- MODEL
Required argument
- FILENAME_SAMPLES
Required argument
evaluate
Evaluate a reduced order model and compare it to truth.
PARAMETERS is a list of parameter values of the form A=VAL B=VAL …
rombus evaluate [OPTIONS] FILENAME_ROM [PARAMETERS]...
Arguments
- FILENAME_ROM
Required argument
- PARAMETERS
Optional argument(s)
plot-bases
Plot the bases (and their errors) of a reduced order model.
rombus plot-bases [OPTIONS] FILENAME_ROM
Arguments
- FILENAME_ROM
Required argument
quickstart
Write a project template to kickstart the creation of a new project.
rombus quickstart [OPTIONS] PROJECT_NAME
Arguments
- PROJECT_NAME
Required argument
refine
Refine parameter sampling to improve an established reduced order model.
rombus refine [OPTIONS] FILENAME_ROM
Arguments
- FILENAME_ROM
Required argument
timing
Compute timing information for a ROM and it’s source model.
rombus timing [OPTIONS] FILENAME_ROM
Options
- -n, --n_samples <n_samples>
Number of samples to use for timing
Arguments
- FILENAME_ROM
Required argument