ModelDB Help for preparing a simulator archive


Note: for extra help specific to NEURON simulator archives please click here.

Procedure for properly "packaging" model source code:

  1. Create a directory that contains all the necessary neuron model files and subdirectories.
  2. In the same directory, put a file (called readme.txt, README, readme.html, or index.html) that contains specific information and instructions on how to use the model. This is the file that ModelDB will display by default in the Model Files window of the model description page (ShowModel.cshtml).
  3. Zip up the directory. On MAC OS X (do not use the method of right-clicking to select Compress "Folder" because it makes an archive which contains extra folders __MACOSX and files .DS_Store only used by the mac operating system) and unix/linux systems an appropriate terminal window command for creating a zip file called from a directory ca1nrn would be
    zip -r ca1nrn
    On MSWin systems create your zip file by right clicking in the Windows Explorer dialog box on the background of the right part of the screen where your model files top level folder is displayed. Select "Send to" and then mouse off to the side to select "compressed (zipped) folder" from the pop-up menu. If desired, change the name of the newly created zip file making sure you retain the ".zip" file extension.
  4. The zip file is now ready to be uploaded to ModelDB.

Email the ModelDB Administrator to ask questions, suggest improvements,or send comments.
Last Modified: July 29nd, 2015