Installation and Update
=======================


.. _catalyst-sec-installation:

Installation
------------

**Recommended:** Download and install the package using *gsm*. This is the
simplest and the recommended way.

#. Get and install gsm ::

      mkdir $HOME/install
      cd $HOME/install
      wget https://data.gempa.de/packages/Public/gsm/gempa-gsm.tar.gz
      tar xvf gempa-gsm.tar.gz
      rm gempa-gsm.tar.gz

#. Initial setup ::

      cd gsm
      ./gsm setup

   Follow the instructions.

#. Installation ::

      ./gsm update
      ./gsm install catalyst

**Manual installation (not preferred):** Download the package file and unpack
it from the directory above the $SEISCOMP_ROOT directory:

.. code-block:: sh

   cd $SEISCOMP_ROOT/..
   tar xvf <package-file-name>

Both procedures result in a complete installation. However, *gsm* remembers
the installation. During updates with *gsm* only required files are kept,
while manual installations eventually accumulate old files, e.g. libraries.


.. _catalyst-sec-dependencies:

System dependencies
-------------------

|package| needs a few system packages in addition to |scname|, mainly Qt 6
libraries. The package ships install scripts for
the supported distributions in
:file:`@DATADIR@/deps/<distribution>/<version>/install-catalyst.sh`.
Install the dependencies with the |scname| helper as root or with sudo:

.. code-block:: sh

   seiscomp install-deps catalyst

Scripts are provided for Debian 12 and 13, Ubuntu 22.04, 24.04 and 26.04,
and RHEL 8, 9 and 10.


Optional components
-------------------

* **Origin score:** the *Score* column and the *Score* QC metric use the
  OriginMultiFeature score processor of :program:`scevent`. Load the
  ``scoremf`` plugin as described in
  :ref:`configuration <catalyst-sec-configuration>`. Without it the score
  shows N/A and everything else works.
* **Topography:** the 3D view draws topography from GEBCO tiles if they are
  found in the folder set by ``demPath``.
* **Grid search:** the scautoloc grid-search nucleator needs a scautoloc
  :file:`grid.conf` file, and optionally a :file:`station.conf` file.


Package update
--------------

For updating apply the same procedure as for
:ref:`installation <catalyst-sec-installation>`. We recommend to use *gsm* for
updating. Old files not required or provided with the new version will be
removed. Close |appname| before updating ::

   gsm update
   gsm install catalyst

.. note::

   * During updates all files provided with the package are overwritten,
     including default configurations. User-defined configurations, such as
     :file:`@SYSTEMCONFIGDIR@/catalyst.cfg` and the profile files, are not
     changed. In order to keep changes of files also provided by the
     installation package, give different names to the changed files.