.. _magienable:

Setting up MAGI
===============

Setting up a MAGI enabled experiment on DETER
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

MAGI is not tied to any particular testbed architecture. Following are basic
instructions on how to setup an experiment with MAGI on DETER/Emulab.

If you aren’t already familiar with DETER, please go through the
`tutorial <https://trac.deterlab.net/wiki/Tutorial>`_ on how to setup an
experiment.

Begin a new experiment and load the ns file that defines the network topology.

A simple ns file modification is required to support loading the MAGI backend
on each experiment node. Run the MAGI bootstrap script as root on each node at
startup. The bootstrap script installs the MAGI distribution along with the
supporting tools, and runs a MAGI daemon process.

.. code-block:: tcl

    tb-set-node-startcmd $node "sudo python /share/magi/current/magi_bootstrap.py"

MAGI can be run with user specific configuration too.
The :ref:`magiconfig` section has more information on that.

The :ref:`magidev` section has information about running the developement
version of MAGI rather than the currently released version.

Next create and swap in the experiment.

Once the experiment is swapped in, you can then use the MAGI :ref:`orchestrator`
to execute the experiment procedure.


Availability
^^^^^^^^^^^^

The MAGI system is divided into **magicore** and **magimodules**.

The **magicore** system consists of
the group communication, control, and data management infrastructure.

The **magimodules** are agent function implementations that enable
a particular behavior on the experiment nodes.

magicore
--------

A current version distribution of MAGI is available for use on DETERLab at:

.. code-block:: bash 

     /share/magi/current/
     
The MAGI codebase is also available at a publically accessible repository.

.. code-block:: bash

    https://github.com/deter-project/magi.git


magimodules
-----------

The agents along with supporting documentation and files are located at:

.. code-block:: bash 

     /share/magi/modules/
     
The MAGi modules are also available at a publically accessible repository.

.. code-block:: bash

    https://github.com/deter-project/magi-modules.git

The :ref:`magilearn` section would give you a brief overview of creating MAGI
enabled experiments.

In the :ref:`magicases` section we present several examples of how to start the
MAGI system and deploy the agents.