.. _sec-installation:

Installation
============


Install DeepC
--------------

You may install and update the DeepC package using :cite:t:`gsm` or by
unpacking a package file which you need to download first. Our preferred
installation path works with gsm.

* **Installation using gsm:**

  First time only (works also for |scname| and all other gempa modules):

  #. Get and install gsm :cite:p:`gsm` as outlined in the
     `gsm documentation <https://docs.gempa.de/gsm/current/base/installation.html>`_ .
  #. Set up gsm as outlined in the
     `gsm documentation <https://docs.gempa.de/gsm/current/base/installation.html#initial-setup>`_ .

  Regular DeepC installation and update:

  .. code-block:: bash

     cd $HOME/install/gsm
     ./gsm update
     ./gsm install deepc

  This installs four packages:

  * **deepc** - this application
  * **dlbase** - dependency package for deep learning applications
  * **dlmodels-class** - DL models, installed according to the *gsm*
    configuration of data_dir in :file:`gsm.conf`, typically /home/data/dlmodels
  * **dlmodels-pick** - more DL models, installed according to the *gsm*
    configuration of data_dir in :file:`gsm.conf`, typically /home/data/dlmodels

  The DL models are described in section :ref:`deepc-available-models`.

* **Unpacking the DeepC package file** (not recommended):

  #. Download the DeepC package TAR ball from our package server. The server
     address and login credentials will be communicated with you. The file name
     will take a structure like
     :file:`deepc-<version>-seiscomp-<SC version>-<OS>-<OS version>-<architecture>.tar.gz`.
     The downloaded file must match your current version of |scname| and your
     operating system.
  #. Unpack the file and extract the package it into your |scname| installation,
     e.g.:

     .. code-block:: bash

        cd $SEISCOMP_ROOT/..
        tar zxvf deepc-<version>-seiscomp-<SC version>-<OS>-<OS version>-<architecture>.tar.gz

     The DL models and the dependency packages must also be installed
     accordingly.

.. note::

   * The novelties of installed package are summarized in the
     :ref:`changelog <sec-changelog>`.
   * While :cite:t:`gsm` takes care of cleaning up the installation from
     obsolete files, installation by unpacking does not and such obsolete files
     may accumulate over time.


Install dependencies
--------------------

DeepC requires no further software dependencies to be installed other than
those for |scname|.