SimExperiment Setup

Setting up a simulation experiment

 

  1.  Chose a meaningful folder name for your experiment

•Try to keep it short (up to 20 chars should be normally sufficient), but not too short (avoid cryptic names like x3 project23 etc.)

•Don't use spaces or special chars in the name (I recommend to use only letter, digits and underscore _ )

•Safest way is to use only small letters, e.g. agmip_wheat_p4, et_study

•Using capital letters for first letter of a word (called CamelCase) is also an option: AgmipWheatP4, ETStudy

   2. Open Eclipse and create the experiment folder in simplace_run/simulation/<yourname>/my_sim_experiment

   3. Create subfolders (folders in italic are optional)

•solution

•data

•project

•misc

•doc

   4. Create a ReadMeFirst.txt

   5. Go to Simplace Redmine website and create a new ticket (called issue)

•Go to http://svn.simplace.net

•Log in with your username and passwort

•Go to the simplace_run subproject http://svn.simplace.net/projects/simplace_run

•Create a New issue

   6. Fill in the data for the new ticket

•Tracker: select QM-Documentation

•Subject: Title of your experiment/paper @ Journal (if journal not known yet, use Unknown)

•Description: Give a short description and include additional information as:

                 Name of the Folder, where you put your experiment

                 Type of experiment: paper, data submission etc.

                 Name of co-authors from our group

•Assignee: chose your name from the list

•Target version: chose simplace_run/QM Tickets

•Don't forget to click on Create ;)

•Remember the ticket number - it's the number that starts with # if you display your ticket

   7. Go back to Eclipse and add/create your solutions, data, projects etc.

   8. Create runs in simplace_run/runs/net/simplace/sim/runs/<yourname>/ to run your experiment

   9. You can optionally create unittests to automatically check integrity of your experiment

   10. Commit your work

•Select the simulation experiment folder

•Select coresponding runs/tests (by holding CTRL pressed, you can select multiple folders)

•Don't select other users folders!

•NEVER select output folder

•Select Team->Commit (via right click's context menue)

•Check if the selection of files is correct

•Enter a meaningfull commit comment

•Add the ticket number to the comment with the keyword refs , e.g. Set up of Agmip Raspberry simulation (refs #42)