Buddies are small tools that help scientific developers in order to complete the modelling and/or development works. They are usable from the command line, using the --buddyhelp, --buddy and --buddyopts options. Four buddies are available:
func2doc newfunc newdata convert Options are given to buddies through a comma-separated list of key=value arguments, using the --buddyopts command line option.
General usage is:
openfluid-engine --buddy buddyname --buddyopts abuddyopt=avalue,anotherbuddyopt=anothervalue
The func2doc buddy extracts scientific information from the source code of simulation functions. It uses the function signature and LaTeX-formatted text placed between the <func2doc> and </func2doc> tags into C++ comments. From these sources of information, it builds a LaTeX document which could be compiled into a PDF document and/or HTML pages.
The func2doc buddy can also use information from an optional sub-directory named doc, located in the same directory as the input source file. The information in the doc subdirectory should be linked to the information from the source code using LaTeX \input command. The func2doc buddy is available on UNIX only systems (Linux, MacOSX).
Required options:
inputcpp : path for cpp file to parse outputdir : path for generated files Other options:
html : set to 1 in order to generate documentation as HTML files pdf : set to 1 in order to generate documentation as PDF file tplfile : path to template file
Usage example:
openfluid-engine --buddy func2doc --buddyopts inputcpp=/path/to/cppfile.cpp, outputdir=/path/to/outputdir,pdf=1
The newfunc buddy generate a skeleton source code of a simulation function, using given options.
Required options:
cppclass : C++ class name of the function funcid : ID of the function Other options:
authoremail : email(s) of the author(s) of the function authorname : name(s) of the author(s) of the function outputdir : path for generated files
Usage example:
openfluid-engine --buddy newfunc --buddyopts funcid=domain.subdomain.process.method, outputdir=/path/to/outputdir
The newdata buddy generate a skeleton dataset.
Required options:
outputdir : Output directory for generated dataset
Usage example:
openfluid-engine --buddy newdata --buddyopts outputdir=/path/to/outputdir
The convert buddy converts a dataset from a specific version format to another one. Currently, conversion is possible from 1.3.x format to 1.4.x format, and from 1.4.x format to 1.5.x format
Required options:
convmode : Conversion mode. Available modes are: 13_14, 14_15 inputdir : Input directory for dataset to convert outputdir : Output directory for converted dataset
Usage example:
openfluid-engine --buddy convert --buddyopts convmode=13_14, inputdir=/path/to/inputdir,outputdir=/path/to/outputdir
1.7.6.1