Administrative toolbar

Model Library Tutorial

To contribute a model and its documentation to the Library, you need to be logged in to OpenABM as an Affiliate or Full member of CoMSES Net (Network for Computational Modeling in the Social and Ecological Sciences), a simple process. A membership is needed for security reasons (to avoid postings by spam bots). To become a member and learn more about CoMSES membership go to: CoMSES Membership Page.

The model upload system guides you through a sequence of steps that asks you to provide relevant information, such as a reference to an associated publication, the documentation of your model, the files with model code, which programming platform is used, etc. The Computational Model Library requires a description of the model that enables others to understand its purpose and structure, and to replicate your results. The ODD protocol (reference below) is recommended as a format for documenting models, but use of this protocol is not a requirement.


Begin Model Submission

First, you must navigate to the model library page from the navigation bar on the left side of the page. Next, as long as you are logged in, click Add to begin the process. Click here to open the Models page in a new window.


PAGE 1 of 6

You should now be on the first of 6 pages where you can begin uploading information about your model. On this page you will input the title of the model, and a description of the model (plus a short summary that is used in model highlight blocks and search results.) Think of the model description here like a publication abstract: concise and clear on the purpose of the model. In-depth details about the design and logic of the model should be documented in an ODD Protocol document, which you can upload on Page 4.

You will also need to enter the name of at least one model author. You as the uploader and owner of the model do not have to be the same person as the model author (E.G. if a student or assistant is uploading a model for someone else, or if the second author of a model is actually uploading a model). You can provide as many authors as necessary by clicking “Add Author”. Complete the author information as you wish the names to appear in the bibliographic citation (to be explained fully later.)

The final section on the bottom of the page is for the keywords you wish to associate with your model. Enter each tag, one at a time. As you type a tag, the field will suggest possible tags that are already in use. If your tag is not already in use, then click “Add.” Once the tag has been added, you may then add another tag.

Click Next when you have finished adding information. NOTE: It is possible to go back in the submission process if you use the browser’s back button.


PAGE 2 of 6

On this page, you may provide a bibliographic reference to a publication describing or discussing the model you are uploading. This allows you to link your model to your publications.

If your model is a replication of a previous model by yourself or another scholar, check the box “Replicated Model?” and enter the bibliographic reference to that previous work.

You can also upload an image (e.g. a screenshot) and video of your model.


PAGE 3 of 6

Enter your notes about this version of your model. Later, when you edit your model, you will be able to upload a new version of your model (bugfixes, etc.), so use this field to denote differences between your model versions, such as when upgrading your code to work with a newer version of the modeling software.

Select the model platform (e.g. Repast, Matlab) your model runs on, as well as the programming language used (e.g. java, C++), and the operating system if that is relevant.


PAGE 4 of 6

On this page you can upload your model and files related to your model. The only required files to upload are your model and its documentation. If your model contains multiple files you must upload them in a compressed form (e.g. zip, tar). You may also upload any necessary datasets, sensitivity analysis information, or additional files.


PAGE 5 of 6

On this page you can choose a license from those provided for you as well as include any instructions necessary for operating the model. For more information on software licenses see http://en.wikipedia.org/wiki/List_of_software_licenses. If you want to have another license added to the list, please contact us at openabm@gmail.com


PAGE 6 of 6

This is the final page. It gives instructions related to publishing and saving the model. You must click SUBMIT to finalize your submission.

Once you have submitted your model, you will be taken to the submitted model’s page in the model library. This model will not be automatically visible to the public. While your model is unpublished, it will not show up in search results in OpenABM or in public search engines, like Google. THis may be useful, if your model is part of a publication under review. You can share the URL to your model with reviewers, and they will be able to look at it as a part of the review process. But until you publish your model, it will not be index by the public search engines. Once you choose to publish your model, it will be indexed and viewable in search results. It is very difficult to undo this, so make sure you are ready for your model to be accessed by the general public.

After you have finished submitting a model, you may request that the model be certified as an example of best practices. More information about model certification

Once a model is certified it receives a permanent handle or persistent url. Permanent handles can also be awarded to models associated with a publication. More information about permanent handles

AttachmentSize
PDF icon Model_Library_Tutorial.pdf583.66 KB
entropicity