= OMF_WEB TUTORIAL =

== This page gives some general information on omf_web ==

omf_web is a web-based data visualization service that is built on top of
OMF and OML. The source, documentation, and example visualizations can be obtained 
[https://github.com/mytestbed/omf_web here].


== Installing OMF_WEB ==
Omf-Web is a git repository which also uses the omf_oml library functions.
In order to run omf-web, the omf_oml has to be installed as well.[[BR]]
Run the following command[[BR]]

git clone https://github.com/mytestbed/omf_web.git [[BR]]
(To install git: Go to https://help.ubuntu.com/community/Git)

== Installing OMF_OML ==
Go back to the home directory where you have installed omf_web.[[BR]]
git clone https://github.com/mytestbed/omf_oml.git [[BR]]

From any directory or subdirectory to update a git repository:[[BR]]
git update 


== Standard omf_web examples ==

OMF_WEB=where you installed omf_web[[BR]]
$cd $OMF_WEB/example[[BR]]
$ruby -I ../lib -I ../../omf_oml/lib demo/demo_viz_server.rb --port 3100 start[[BR]]

Starts the demo server on port 3100 of localhost machine.[[BR]]
Point your browser to port 3100 on the localhost.[[BR]]
localhost:3100

OpenFlow Demo:
$cd $OMF_WEB[[BR]]
$ruby -I lib -I ../omf_oml/lib example/openflow-gec15/of_viz_server.rb --local-testing --port 3100 start

Starts the openflow server on port 3100 of localhost machine[[BR]]
Point your browser to port 3100 on the localhost[[BR]]
localhost:3100

== Problems with Ruby version ==

Some machines may run Ruby1.8 and some may run Ruby1.9. Some machines have Ruby1.8 and Ruby1.9 running in parallel.[[BR]]
To install Ruby Version Manager(RVM)[[BR]]
https://rvm.io/rvm/install/- Install rvm with Ruby[[BR]]

=== Some other errors ===
''`require': no such file to load -- rubygems''[[BR]]
If you are getting the above error, a gem installation maybe required.[[BR]]
Try the following command:[[BR]]
$sudo apt-get install <name-of-gem>

=== [http://groups.geni.net/geni/wiki/GIMI-GEC16-Tutorials Back to GEC16 GIMI tutorials main page] ===