[[TOC(Documentation/C*, depth=3)]] = How to get started = First, you will need an ORBIT account. Please check the [wiki:Documentation/BUsagePolicy usage policy] if you are eligible. Typically, in order to get an account,one would have to [http://www.orbit-lab.org/userManagement/register register for an account] and get it approved by the PI in charge of the project/institution they wish to be part of. If particular institution is not available, the appropriate PI can [http://www.orbit-lab.org/userManagement/orgReg register] for an institutional account. == Six Steps == A typical experiment requires the following six steps: 1. [[CollapsibleStart(Create resource reservation")]][[Include(Documentation/Short/CreateRes)]][[CollapsibleEnd]] The user needs a set of nodes/resources from a domain to run the experiment on.For the rest of this tutorial we will assume that the the reserveation was made for sb1 domain. 2. [[CollapsibleStart(Login into reserved domain: "ssh username@sb1.orbit-lab.org")]][[Include(Documentation/Short/Login)]][[CollapsibleEnd]] After you receive the confirmation email, you can access the reserved domain by ssh to the corresponding domain console. 3. [[CollapsibleStart(Load an image on the nodes: "omf load -i baseline.ndz -t all")]] [[Include(Documentation/Short/LoadImage)]][[CollapsibleEnd]] Prior to executing the "Hello World" experiment, users need to install an image on the hard disks of the nodes. For this tutorial we will use '''baseline.ndz'''. This image is built on top of '''Ubuntu 12.04''', and is pre-configured with the proper modules and start up scripts to take advantage of the rest of the Orbit [wiki:/Software software] / [wiki:/Hardware hardware]. The imaging process will turn the nodes back off after completing imaging. 4. [[CollapsibleStart(Turn the nodes on: "omf tell -a on -t all")]][[Include(Documentation/Short/TellOn)]][[CollapsibleEnd]] At this point the nodes disks are imaged with the ''baseline'' image and need to be turned back on before proceeding. Give the nodes a couple of minutes to turn on / boot, then check their status with omf stat 5. [[CollapsibleStart(Execute the experiment: "omf exec test:exp:tutorial:hello-world-wireless -- --res1 node1-1.sb1.orbit-lab.org --res2 node1-2.sb1.orbit-lab.org")]][[Include(Software/cOMF/aExec)]][[CollapsibleEnd]] Execute "Hello World" experiment. This is a simple wireless experiment that establishes the !WiFi link between two nodes and transfers data for 60 seconds. Be sure to specify the fully qualified domain names (FQDNs) of the two nodes involved. For the output below, it is assumed that the domain is: '''sb1.orbit-lab.org''' and the two nodes are '''node1-1.sb1.orbit-lab.org''' and '''node1-2.sb1.orbit-lab.org'''. {{{ username@console.sb1:~$ omf exec test:exp:tutorial:hello-world-wireless -- --res1 node1-1.sb1.orbit-lab.org --res2 node1-2.sb1.orbit-lab.org INFO NodeHandler: OMF Experiment Controller 5.4 (git c005675) INFO NodeHandler: Slice ID: default_slice (default) INFO NodeHandler: Experiment ID: default_slice-2013-01-29t01.03.19-05.00 INFO NodeHandler: Message authentication is disabled INFO Experiment: load system:exp:stdlib INFO property.resetDelay: resetDelay = 230 (Fixnum) INFO property.resetTries: resetTries = 1 (Fixnum) INFO Experiment: load system:exp:eventlib INFO Experiment: load test:exp:tutorial:hello-world-wireless INFO property.duration: duration = 60 (Fixnum) INFO property.graph: graph = false (FalseClass) INFO Topology: Loading topology 'system:topo:imaged'. INFO Topology: Loading topology '/tmp/pxe_slice-2013-01-26t22.21.22-05.00-topo-success'. INFO ALL_UP_AND_INSTALLED: Event triggered. Starting the associated tasks. INFO exp: This is my first OMF experiment INFO exp: Request from Experiment Script: Wait for 15s.... INFO node1-1.sb1.orbit-lab.org: Device 'net/w0' reported Not-Associated INFO node1-2.sb1.orbit-lab.org: Device 'net/w0' reported Not-Associated INFO node1-1.sb1.orbit-lab.org: Device 'net/w0' reported 12:B2:78:8E:8D:4F INFO node1-2.sb1.orbit-lab.org: Device 'net/w0' reported 12:B2:78:8E:8D:4F INFO exp: All my Applications are started now... INFO exp: Request from Experiment Script: Wait for 60s.... INFO exp: All my Applications are stopped now. INFO EXPERIMENT_DONE: Event triggered. Starting the associated tasks. INFO NodeHandler: INFO NodeHandler: Shutting down experiment, please wait... INFO NodeHandler: INFO run: Experiment default_slice-2013-01-29t01.03.19-05.00 finished after 1:23 username@console.sb1:~$ }}} 6. You can view the results by pointing a webrowser to: a [http://console.sb1.orbit-lab.org:5054/result/dumpDatabase?expID=default_slice-2013-01-29t01.03.19-05.00 url] of this form: {{{ http://console.sb1.orbit-lab.org:5054/result/dumpDatabase?expID=EXPERIMENT_ID. }}} The exiprment ID is an auto-generated string that is reported during the run of the experiment. In this case it was {{{ INFO NodeHandler: Experiment ID: default_slice-2013-01-29t01.03.19-05.00 }}} It should look something like:[[BR]] [[Image(Result.png,500px)]][[BR]] More information on result analysis can be found [wiki:/Tutorials/a0Basic/Tutorial3 here] 7. (optionally) Save the image [[CollapsibleStart(Save Image with omf: "omf save -n node1-1.sb1.orbit-lab.org")]] [[Include(Documentation/Short/SaveImage)]][[CollapsibleEnd]] If you modified the basiline image and/or added software to it, you want to save it into repository before the end of your time slot! == Where to go from here == If you are still unsure what Orbit is, please read the [wiki:FAQ FAQ] and check other [wiki:Tutorials tutorials].