carputils
Doxygen code documentation for the python framework controlling openCARP
|
You have an openCARP experiment, configured with a .par
parameter file, and you want to turn it into a carputils workflow?
With the script parfile2carputils
included in carputils, you can easily turn such an experiment into a carputils script.
In short, this script creates a basic carputils script which integrates all openCARP options included in your parameter file. You get a carputils experiment reproducing the experiment configured in your parameter file, which you can elaborate on.
From the directory containing your parameter file parameters.par
, run the command
This will produce a carputils script named run.py
containing all openCARP options included in your parameter file.
If your openCARP experiment can be run with
Then it can now also be run with
In order to use parfile2carputils
, you need to have installed carputils
and to have an openCARP experiment parametrized via a parameter file such as the following parameters.par
:
Note: this example is taken from the openCARP example Cellular dynamics heterogeneity.
This experiment is typically run with openCARP using
You can run
in order to generate a carputils script named run.py
, containing all options contained in parameters.par
. This script will be independent from the original parameters file.
If your openCARP experiment can be run with
it can now also be run as a carputils experiment with
In order to get help on other options offered by parfile2carputils
, you can run
.par
fileWith the option --keep-parfile
, you can decide to read parameters from the parameter file instead of copying all options in the carputils script. The parameter file will be copied within the ouput directory, unless a file with the same name already exists.
You can overwrite an existing parameter file with the option --overwrite-parfile
.
Several options allow to customize the ouput carputils script:
--output OUTPUT
: define the location of the output carputils script.--overwrite
: overwrite the output script if it already exists.--author AUTHOR
: provide an author name to be included in the carputils script.