What Is A Model Review?
Model authors may request that their models be reviewed for completeness and Modeling Best-Practices. Models that meet Model Standards will be certified and will display a Certified badge as well as be included on OpenABM’s home page as a Featured Model.
In order for a model to be certified as meeting CoMSES Best-Practices Standards, it must:
- Have well-formatted and commented programming code. This is to ensure other users can understand and replicate the algorithms in your code.
- Be fully documented using the ODD standard for model documentation, or an equivalent documentation protocol. By writing documentation that complies with the ODD, other modelers should be able to replicate your model and its results without having to refer to your programming code. We recommend you look at some of the Certified models in the library to see relevant examples.
- Run correctly with the instructions provided with the model. If the model requires special input files or file structures to run, all must be fully explained in the instructions.
- Correctly simulates the processes it claims to simulate.
When a model is reviewed, it will be examined to verify it meets all these standards. The CoMSES reviewer will provide notes to the model author whether the model meets these standards. If any elements require revision in order to meet the Best-Practices Standards, the author will be given notes on what those steps are.
Hopefully, the Model Review system and model certification will assist the CoMSES Community in recognizing well-developed models and help us all to raise the bar of quality for our field of practice.