wiki:GEC18Agenda/LabWikiAndOEDL/Introduction

Version 19 (modified by thierry.rakotoarivelo@nicta.com.au, 6 years ago) (diff)

--

<-- Back to Main Tutorial Page | Next to Experiment 1 -->

Introduction to LabWiki & OEDL

This section presents the tools which we will use for all experiments in this tutorial.

  • LabWiki is a web-based interface developed at NICTA within the GIMI project. You can use this interface to design, describe and run an experiment using GENI Resources. It was first introduced at GEC17 as part of the GIMI Tutorial. LabWiki's is available on our git repository. In this tutorial, we will all use the instance of LabWiki running at http://labwiki.casa.umass.edu:4000
  • OEDL is a domain-specific language used to describe the orchestration of experiments.

LabWiki

Login in LabWiki

  • If you have already logged in to the GENI Portal, you will be automatically logged in to LabWiki
  • Otherwise, please use your GENI Portal username and password to login
  • You will be asked to agree on sending your GENI Portal information to LabWiki. LabWiki will only use your GENI ID to log you in, so please click on "Send my information"

  • Once logged in you should arrive on LabWiki's main page

Using LabWiki

  • By default, LabWiki's main page is composed of 3 columns: "Plan", "Prepare", and "Execute"

Plan

The purpose of the Plan column is to provide some documentation on the experiment at hand. This is where you would describe for example the goals of this experiment, the hypotheses that it tests, its design, any background information to help understand it, etc... Once you ran your experiment, collected, plotted and/or analysed its generated measurements, this is column is also where you would report and discuss results and conclusions. The document displayed in this Plan column are written using the Markdown syntax.

To display a previously saved document, just start typing its name in the search field below the column's title. A drop-down list of matching documents should appear, and you may then click on the desired one.

Prepare

This column is where you create and/or edit either a) the documents that will be displayed in the Plan column or b) the experiment descriptions that will be executed.

  • To edit an existing document, which is currently displayed in the Plan column, just drag-and-drop the document icon from the Plan column to the Prepare one. Once you are done editing, click the save icon . Once that document is save, you can refresh its view in the Plan column by searching for it again in the search field and loading as previously.

  • To edit an existing document, which is not currently displayed, just use the search field in the Prepare column to type the name of that document. Matching results should appear in a drop-down list. You may see 2 types of file, some with a .md extension, which are Plan documents and others with a .rb extension, which are experiment file descriptions. You may then click on the desired document (with a .md extension), which will be loaded in the Prepare column and ready to be edited.

  • To create a new document, click on the icon on the left of the search field of the Prepare column. You should see a new menu, where you can enter the name for the new document (e.g. another_test). You have to select "Wiki" as the document type in the pull down menu next to the new document's name. Finally, you should click the Create button. To edit the newly created document, you have to first load it in the Prepare column as described previously.

  • To load and edit an existing experiment file description, just follow the same steps as above for loading/editing a document, but this time make sure to select an experiment file which have a .rb extension in the pull-down list.

  • To create a new experiment file description, just follow the same steps as above for creating a new document, but make sure to select "Ruby" as the document type in the pull down menu next to the new experiment file name.

OEDL

Help & Additional Resources


<-- Back to Main Tutorial Page | Next to Experiment 1 -->

Attachments (20)

Download all attachments as: .zip