.. _software-install-yum:

Installing via YUM
==================

We provide YUM repositories of the IPbus software (pre-built binaries + configuration files) for RedHat 7, 8 and 9, for AMD64 and ARM64 machines. We also have a YUM repository for RedHat 7 on ARMv7. These same repositories can also be used for equivalent RedHat-derivative operating systems, e.g. CentOS7, 8 and 9, Alma/Rocky 8 and 9. These YUM repositories should be used wherever possible. If you want to help on the development - then you should check the :ref:`compile from source instructions <how-to-compile-the-software>`.

1. If you already have a previous version of the IPbus suite (i.e. v2.0.0 to v2.7.9) installed on your computer, first uninstall this old version:

   .. code-block:: sh

     sudo yum groupremove uhal

2. Download the appropriate YUM repo file, and copy to ``/etc/yum.repos.d/``, renaming to ``ipbus-sw.repo``:

   * For RedHat/CentOS7: Two builds are available ...
   
     * Compiler: GCC4. Dependencies: boost 1.53 and pugiXML 1.8 (from EPEL repos):

       .. code-block:: sh

         sudo curl https://ipbus.web.cern.ch/doc/user/html/_downloads/ipbus-sw.centos7.repo -o /etc/yum.repos.d/ipbus-sw.repo

     * Compiler: GCC8. Dependencies: boost 1.66 and pugiXML 1.9 (provided in the IPbus repo)):

       .. code-block:: sh

         sudo curl https://ipbus.web.cern.ch/doc/user/html/_downloads/ipbus-sw.centos7_gcc8.x86_64.repo -o /etc/yum.repos.d/ipbus-sw.repo

   * For RedHat/CentOS/Alma/Rocky 8:

     .. code-block:: sh

       sudo curl https://ipbus.web.cern.ch/doc/user/html/_downloads/ipbus-sw.centos8.repo -o /etc/yum.repos.d/ipbus-sw.repo
       sudo yum-config-manager --enable powertools

   * For RedHat/Alma/Rocky 9:

     .. code-block:: sh

       sudo curl https://ipbus.web.cern.ch/doc/user/html/_downloads/ipbus-sw.el9.repo -o /etc/yum.repos.d/ipbus-sw.repo
       # ONLY if you're using the ControlHub: Add Fedora 34 repo (base of RHEL9) for Erlang
       sudo curl https://ipbus.web.cern.ch/doc/user/html/_downloads/fedora34-updates.repo -o /etc/yum.repos.d/fedora34-updates.repo
       sudo dnf -y install https://ftp-stud.hs-esslingen.de/pub/Mirrors/archive.fedoraproject.org/fedora/linux/releases/34/Everything/x86_64/os/Packages/f/fedora-gpg-keys-34-1.noarch.rpm

3. Install the software:

   * To just install uHAL:

     .. code-block:: sh

       sudo yum clean all
       sudo yum groupinstall uhal

   * To just install the ControlHub:

     .. code-block:: sh

       sudo yum clean all
       sudo yum groupinstall controlhub

   * To install both uHAL and the ControlHub:

     .. code-block:: sh

       sudo yum clean all
       sudo yum groupinstall uhal controlhub

   Note: On CentOS7, the debug info for libraries and executables (used e.g. to show stack traces in ``gdb``) is packaged in a different set of RPMs, that belong to the ``uhal-debug`` YUM group. These RPMs can be installed on CentOS7 as follows:

   .. code-block:: sh

     sudo yum groupinstall uhal-debug

**N.B.** The IPbus software RPMs install almost all of their files under ``/opt/cactus``. So when running applications that use uHAL, you need to update your environment variables accordingly:

.. code-block:: sh

  export LD_LIBRARY_PATH=/opt/cactus/lib:$LD_LIBRARY_PATH