Adding New Content to KIM

All content on openkim.org is open source and uploaded by researchers from the atomistic simulation community for the benefit of their colleagues. You need to be a KIM Member (click to join), and then you can:

Contribute a Model

Users can upload Portable Models or Simulator Models to openkim.org. Uploaded models will be mated with all compatible Verification Checks (VCs) to check coding integrity, and all compatible KIM Tests to compute property predictions. Model information along with all VC and Test results are displayed in a dedicated model page accessible through the browse interface.

  • For Portable Models that are designed to leverage an existing Model Driver, or for Simulator Models, the upload process simply involves filling out an online form with the model information.

    For a Portable Model:

    • Name of the Model Driver (selected from a list)
    • Parameter file(s) (upload the files)
    • List of species supported by the model
    • Title (should conform to these guidelines)
    • Description
    • Content origin (optional)
    • Content other location (optional)
    • Disclaimer (optional)
    • Source citations (can be uploaded as BibTex files)
    • Distribution license (selected from a list)

    For a Simulator Model:

    • Name of simulator
    • Type of potential (selected from the list of potentials supported by the simulator)
    • Simulator version
    • Simulator script used to define the potential (auto-generated and typically doesn't need to be altered)
    • Units
    • Parameter file(s) (upload the files)
    • Title (should conform to these guidelines)
    • Description
    • Content origin (optional)
    • Content other location (optional)
    • Disclaimer (optional)
    • Source citations (can be uploaded as BibTex files)
    • Distribution license (selected from a list)

    Most of the information entered in the form can be edited by the user who contributed the model after it is approved by the KIM Editor and accepted into the system.

    To upload a Portable Model (employing a Model Driver) or a Simulator Model, sign in or create your KIM user account, go to the front page, and click on the "Contribute a Model" button to access the upload forms.

  • Users may also upload stand-alone Portable Models that do not employ a Model Driver. In this case, the Portable Model consists of computer code that must conform to the KIM Application Programming Interface (API) Portable Model Interface (PMI). See the KIM API page for information on how to develop such models.

    Stand-alone Portable Models are uploaded as an archive with all required files enclosed. To upload an archive, sign in or create your KIM user account, click on the cloud in the upper-right corner of the page, and then click on "Portable Model" in the archive upload section.

Contribute a Model Driver

KIM Model Drivers are uploaded as an archive with all required files enclosed. To upload an archive, sign in or create your KIM user account, click on the cloud in the upper-right corner of the page, and then click on "Model Drivers" in the archive upload section.

Contribute a Test or a Test Driver

KIM Tests are uploaded as an archive with all required files enclosed. To upload an archive, sign in or create your KIM user account, click on the cloud in the upper-right corner of the page, and then click on "Test" or "Test Driver" in the archive upload section. For more information on how to create Tests, see the Introduction to KIM Tests.

Contribute Reference Data

Reference Data is uploaded as an archive with all required files enclosed. To upload an archive, sign in or create your KIM user account, click on the cloud in the upper-right corner of the page, and then click on "Reference Data" in the archive upload section. For more information on Reference Data, see the KIM Content page.

Contribute a Property Definition

KIM Property Definitions are formal schema defining the structure of KIM properties computed by KIM Tests or uploaded as Reference Data. For a detailed explanation, see the KIM Properties Framework. Contributions require the Property Definition in EDN format and an associated Property Synopsis (HTML template for displaying results for this property). When you are ready to upload sign in or create your KIM user account, click on the cloud in the upper-right corner of the page, and then click on "Property Definition" in the archive upload section.

Contribute a Visualizer

For information on KM Visualizers and how to develop and upload them, see Visualizing KIM Test Results.

Managing Contributed Content

A KIM member can manage their contributed content by signing in to their KIM user account and clicking on the cloud in the upper-right corner of the page. This page provides the following information:

  • links to uploading new content
  • list of items in progress (content that the user started to upload but has not completed)
  • link to the list of all items uploaded by the user (clicking on any item, will bring the user to the item's page and allow them to edit most of the item's information).