Command line tool: gen_json
| Module | cltools |
|---|---|
| Description | Input |
| print out a json file that contains the pluemd syntax | command line args |
Details
gen_json constructs a json file that includes a dictionary of actions, the keywords for those actions and the components and outputs this to standard output
This command is used during the build process of plumed. It constructs a json file that contains documentation information on all actions and cltools. This json file is then used by the python package PlumedToHTML. This package is used to construct the example input files that appear in the plumed nest, plumed tutorials and this manual.
You will likely not ever need to run this command. When it runs during the build proess we use the following command:
plumed --no-mpiIgnore any mpirun commands and turn off MPI. gen_jsonprint out a json file that contains the pluemd syntax More details --actionsa file containing one line descriptions of the various actions action_list > syntax.json What is printed on standard output is directed to a file with this name.
You can find the syntax json file that is generated by this comamnd as plumed2/json/syntax.json.
Syntax
The following table describes the command line options that are available for this tool
| Keyword | Description |
|---|---|
| --help/-h | print this help |
| --actions | a file containing one line descriptions of the various actions |