jftsang / mdpmflc

A web interface for MercuryDPM
0 stars 0 forks source link

Documentation and examples explaining how to write MDPM drivers that are compatible with mdpmflc #5

Open jftsang opened 4 years ago

jftsang commented 4 years ago

mdpmflc starts a driver by calling /path/to/NameOfDriver parameters.config [otherflags], where parameters.config is a file that contain parameters for this driver governing the simulation. We need documentation on how to use MercuryDPM to parse this file, so that there is standardisation.

In theory, the config files are completely freeform. For my own drivers, I use the format

key1 value1
key2 value2

and use a std::map object to store these parameters.

We also need docs/standards for how to pass other arguments to your driver, so that the other flags can be interpreted properly by MercuryDPM's built-in argument parser.