.. _gen_control_karabo_init:

Initializing a Karabo Environment for an Instrument
===================================================

To initialize a Karabo environment for a specific instrument please use the instructions for one of the
following scenarios:

In the Hutch/Control Room
~~~~~~~~~~~~~~~~~~~~~~~~~

The control network client PCs should already point to the correct Karabo environment, so usually

.. code-block:: console

   karabo-gui

should suffice. If the `karabo-gui` command is not found, try

.. code-block:: console

   source ~/karabo/activate.

If this does not work either, please ask an instrument scientist or call CAS OCD.

On exflgateway - GUI only
~~~~~~~~~~~~~~~~~~~~~~~~~

Log onto exflgateway (:ref:`gen_control_login`). Then activate the most up-to-date Karabo environment and start the GUI:

.. code-block:: console

   source /opt/karabo/karabo/activate
   karabo-gui

In the login dialog,

.. figure:: gen_control_karabo_init_logon.png

   The Karabo logon dialog.



connect to the GUI server corresponding to your instrument:

========== ===================
Instrument Hostname
========== ===================
SPB        spb-rr-sys-con-gui1
FXE        fxe-rr-sys-con-gui1
SQS        sqs-rr-sys-con-gui1
SCS        scs-rr-sys-con-gui1
MID        mid-rr-sys-con-gui1
HED        hed-rr-sys-con-gui1
========== ===================

On exflgateway - iKarabo
~~~~~~~~~~~~~~~~~~~~~~~~

Log onto exflgateway (:ref:`gen_control_login`). Then activate the most up-to-date Karabo environment and start the GUI:

.. code-block:: console

   source /opt/karabo/karabo/activate

You will now need to set-up the broker information for the respective instrument:

.. code-block:: console

   export KARABO_BROKER_TOPIC=<INSTRUMENT>
   export export KARABO_BROKER=tcp://<SASE>-br-sys-broker-1:7777

where you should fill in `<INSTRUMENT>` and `<SASE>`:

========== ============ ======
Instrument <INSTRUMENT> <SASE>
========== ============ ======
SPB        SPB          sa1
FXE        FXE          sa1
MID        MID          sa2
HED        HED          sa2
SCS        SCS          sa3
SQS        SQS          sa3
========== ============ ======

Now you can run `iKarabo`:

.. code-block:: console

   ikarabo

Verify correct settings, but obtaining a list of devices for the instrument

.. code-block:: python

   getDevices()