Changes between Version 2 and Version 3 of GEC22Agenda/LabWiki/Instruction


Ignore:
Timestamp:
03/11/15 15:20:03 (4 years ago)
Author:
divyashri.bhat@gmail.com
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GEC22Agenda/LabWiki/Instruction

    v2 v3  
    1616
    1717The first thing we need to do is login to the portal.
    18 Go to [portal.geni.net Geni Portal] press the Use GENI button
    19 and from the Drop Down menu select your institution. If you got an account through the GENI Identity Provider, please select GENI Project Office.
     18Go to [portal.geni.net Geni Portal] press the Use GENI button.
     19From the Drop Down menu select your institution. If you obtained an account through the GENI Identity Provider, please select GENI Project Office.
    2020Tip: Start typing the name of your institution and see the list become smaller.
    2121You will be transferred to the Login Page of your institution. Fill in your username and password.
     
    2525* At the portal home page press the create slice from your project.
    2626
    27 Tip: If you are not a member of any project and you don't know how to procede, email us
     27Tip: If you are not a member of any project and you don't know how to proceed, email us (geni-users@googlegroups.com)
    2828
    2929* Name your slice something like xxxhello (where xxx are your initials)
    3030
    31 * When the slice page loads up, press the Slice Jacks (beta) button.
     31* When the slice page loads up, press the Slice Jacks button.
    3232
    3333* Once the Jacks window loads, click the Add Resources button placed at the top left part of the screen.
     
    5757After you are done with your experiment, you should always release your resources so that other experimenters can use the resources. In order to cleanup your slice :
    5858
    59 *Press the Delete button in the bottom of your Jacks canvas.
     59*Press the Delete button at the bottom of your Jacks canvas.
    6060
    61 Wait and after a few moments all the resources will have been released and you will have an empty canvas again. Notice that your slice is still there. There is no way to delete a slice, it will be removed automatically after its expiration date, but remember that a slice is just an empty container so it doesn't take up any resources.
     61After a few moments all the resources will have been released and you will have an empty canvas again. Notice that your slice is still there. There is no way to delete a slice, it will be removed automatically after its expiration date, but remember that a slice is just an empty container so it doesn't take up any resources.
    6262
    6363== Useful links ==
     
    7171
    7272== Introduction ==
    73 LabWiki is a web-based tool developed at Nicta. It is used to design, describe and run experiments on GENI test bed and perform active measurements.
     73LabWiki is a web-based tool developed at NICTA. It is used to design, describe and run experiments on the GENI test bed and perform active measurements.
    7474
    7575== OEDL ==
     
    9191
    9292Note:
    93 If you are logged in to Geni portal, you are logged in to LabWiki as well. It is recommended to use chrome browser to access LabWiki. In other browsers, the graphs in LabWiki may not be displayed properly due to some issues in JavaScript used in LabWiki.
     93If you are logged in to GENI Portal, you are logged in to LabWiki as well. It is recommended to use chrome browser to access LabWiki. In other browsers, the graphs in LabWiki may not be displayed properly due to some issues in JavaScript used in LabWiki.
    9494
    9595== Structure of LabWiki ==
     
    9797
    9898== Plan: ==
    99 This panel is used to view Markdown scripts. This column is usually used to provide some instructions on the experiment. This is also the place where you describe for example, the goals of the experiment, the hypotheses that it tests,  its design, any background information to help understand it. When the experiment is finished, the graphs can be dragged and dropped in to this panel to take a look. To open a document, start typing its name in the search box below the column's title. You can choose the required one from the drop down list that shows the matching documents.
     99This panel is used to view Markdown scripts. This column is usually used to provide some instructions about the experiment. This is also the place where you describe for example, the goals of the experiment, the hypotheses that it tests,  its design, any background information to help understand it. When the experiment is finished, the graphs can be dragged and dropped in to this panel to take a look. To open a document, start typing its name in the search box below the column's title. You can choose the required one from the drop down list that shows the matching documents.
    100100
    101101== Prepare ==
     
    104104*       Markdown scripts that can be viewed on the plan column
    105105
    106 *       OEDL  documents that have the experiment scripts written in Ruby.
     106*       OEDL documents that have the experiment scripts written in Ruby.
    107107
    108108A new document can be created by clicking on the "+" button below the column's title. You will have the option of choosing either the "wiki" option or "oedl" option. "wiki" option should be chosen for markdown scripts. Also, a document opened in the plan column can be dragged and dropped in to this column for editing. Click save icon to save the document.
     
    113113This panel is used to start a new instance of an experiment, monitor the execution, view the logs and graphs.
    114114
    115 *       To start a new instance of an experiment, select and load the experiment in the Prepare column as described above. If required you may want to edit and save that experiment
     115*       To start a new instance of an experiment, select and load the experiment in the Prepare column as described above. If required you may want to edit and save that experiment.
    116116
    117 *       Then drag the icon   next to the experiment's name from the Prepare column, and drop it in the Execute column. You should now see in the Execute column some information about this new experiment instance.
     117*       Then drag the icon next to the experiment's name from the Prepare column, and drop it in the Execute column. You should now see in the Execute column some information about this new experiment instance.
    118118
    119119*       In addition to standard experiment parameters (e.g. Name, Slice, Scripts), all configurable experiment properties are displayed in the Execute column , where you can change their default values.
     
    138138
    139139
    140 == Gitolite- coming soon ==
    141 Labwiki now provides SSH Access to LabWiki Managed Git Repository with the help of Gitolite. By integrating with Gitolite, LabWiki now allows end users to access and update git repositories via standard git command. They could now use their favorite text editor to create and modify experiment scripts; use normal git work flow to synchronize changes. Gitolite need not be installed on the same server as Geni.
     140== Gitolite - coming soon ==
     141Labwiki now provides SSH Access to LabWiki Managed Git Repository with the help of Gitolite. By integrating with Gitolite, LabWiki now allows end users to access and update git repositories via standard git command. They could now use their favorite text editor to create and modify experiment scripts; use normal git work flow to synchronize changes. Gitolite need not be installed on the same server as GENI.
    142142
    143 == Instructions to grade an experiment- coming soon ==
    144 Labwiki can now be used to automatically grade the students' experiments. There is a configuration file with global permissions. It will have the details of whether people are professors or students. There will be three repositories serving each purpose.
     143== Instructions to grade an experiment - coming soon ==
     144Labwiki can now be used to automatically grade the students' experiments. Currently, there is a configuration file with global permissions. Users will be categorized into professors by specifying an educator role within this configuration file.
    145145
    146 * The system repository is the global repository which will have the files created by the instructor. This the repository shared between Professors and the students. Professor will have write permissions for files in this repository whereas students will have Read-only access.
     146This feature incorporates three different repositories:
    147147
    148 * The students will have their own repositories will have files pertaining to each student. They can create their own files.
     148* The system repository is the global repository which will have files created by the instructor. This repository is shared between Professors and students. A Professor will have write permissions for files in this repository whereas students will have Read-only access.
    149149
    150 * There will be a submission repository which will have all the submission files of the students.
     150* The students will have their own repositories where they can create their own files (Markdown and OEDL ).
    151151
    152 * The first step for the professor is to create Mark down file providing instructions and reading materials required to run an experiment for the students.
     152* There will be a submission repository which will have all the submissions (Markdowns) of the students.
    153153
    154 * The second step is to create OEDL scripts to run the experiment.To know more about OEDL, check [http://mytestbed.net/projects/omf6/wiki/OEDLOMF6](http://mytestbed.net/projects/omf6/wiki/OEDLOMF6)
     154To create an Experiment a Professor must:
    155155
    156 * The students can login to LabWiki and view the files loaded by the Professor. They will not be able to edit the original files.
     156* Create a Markdown file providing instructions and reading materials required to run an experiment for the students.
    157157
    158 * Student has to create his/her own OEDL file, copy the content from original file, make modifications if necessary and run the experiment.
    159 
    160 * Once the experiment is complete, students have to create a new mark down file for submission. They can drag the graphs of the experiment into the file and and include necessary details about the experiment.. When they are ready to submit the file, they can click "share page" icon in the plan panel of Labwiki.
    161 
    162 * The shared files from the students will be loaded into the submission repository
    163 
    164 * Currently, there is a separate markdown file which will have the links to all the student submissions. This file will can be accessed only the Professor.
     158* Create OEDL scripts to run the experiment. To know more about OEDL, check out [http://mytestbed.net/projects/omf6/wiki/OEDLOMF6](http://mytestbed.net/projects/omf6/wiki/OEDLOMF6)
    165159
    166160* Professors can write a user-defined event such that it gets triggered only if the experiment has run successfully. They can define the events that need to start upon triggering. For an example, check http://groups.geni.net/geni/wiki/GEC22Agenda/LabWiki/ModuleA
    167161
     162To run an Experiment a Student will:
     163
     164* Login to LabWiki and view the files loaded by the Professor. They will not be able to edit the original files.
     165
     166* Create his/her own OEDL file (if required), copy the content from original file, make modifications as necessary and run the experiment.
     167
     168* Once the experiment is complete, students have to create a new Markdown file for submission. They can drag the graphs of the experiment into the file and and include necessary details about the experiment. When they are ready to submit the file, they can click "share page" icon in the leftmost-corner of plan panel of Labwiki.
     169
     170* The "Share Page" creates a submission file with the student's user name in the submission repository
     171
     172To Grade a submission
     173
     174* A separate markdown file (currently, called submission.md) which will have links to all the student submissions can be accessed only by the Professor and is hidden from students.
     175* An instructor has to simply bring up this Markdown in the Plan window and click on a student's submission (again a Markdown script) to grade it.
     176
     177
    168178[wiki:GEC22Agenda/LabWiki Back: LabWiki Tutorial]