Installation

Download and/or clone repository

You can always clone the code and docs by running:

git clone https://github.com/ifountoul/SSA2py.git

Hardware Requirements

  • The software is developed in a manner to be able to be deployed from PC/Laptop to High-Performance Servers with or without a GPU device.

  • Tested on Ubuntu 22.04.2 LTS and Windows 11 Pro - WSL 2.

  • The GPU device must support CUDA GPU programming standard.

Prerequisites

  • Install conda (here). Tested on 4.12.0.

  • (Optional) Install NonNinLoc (here). For traveltime tables calculation.

  • Make sure that you have conda-forge in your channels (conda config --show channels). You can add it by executing conda config --add channels conda-forge.

  • If you install SSA2py on a brand new system install the C and C++ compilers before installing Anaconda.

Note

In order to succesfully compile NonNinLoc you will need a C compiler, such as gcc.

Installation

  1. Download and extract the source code.

  2. Setup Python3 and the associated packages on a conda environment. You will need to source the environment.yml inside your conda workspace. From the terminal run:

    cd SSA2py

    conda env create -f environment.yml

  3. Activate conda environment.

    conda activate SSA2PY

  4. Create the default events (Events Dir) and traveltimes (Traveltimes/save) directories as defined in the default config file.

  5. Download files necessary for plotting.

    python3 SSA2py.py --download

Test Functionality

Evaluate the setup by running in terminal:

  • Check the help screen

    python3 SSA2py.py

  • Run a benchmark event (usage in detail here)

    python3 SSA2py.py -c config.yaml -e noa2019gfqmt