Installation

We recommend using conda to install Python packages. It comes shipped via Anaconda (or Miniconda for a smaller footprint) - a Python distribution that allows to quickly configure specific Python environments, e.g. specific package versions etc.. If you are interested in the whole Python toolbox (corresponding to method ‘MPS’ of Scholz et al., 2020), carry out steps 1-4. If you are aiming only for the MATLAB files (corresponding to methods ‘ISAE’, ‘UCLA’, or ‘IPGP’) or the deglitched data provided along with this package for a selection of seismic events, you just need to do step 3.

  1. Install Anaconda or Miniconda.

  2. Open a terminal (Windows: Anaconda powershell), create a new environment and activate it (choose an environment name you prefer, here seisglitch is chosen):

    conda create -n seisglitch python=3.7 numpy=1.16 scipy=1.5.3 obspy=1.2.2 pyyaml -c conda-forge
conda activate seisglitch

3. Go to to your prefered parent folder (no need to create an extra package folder, this will be done anyway), download SEISglitch via git (on Windows, you may need to install “git” first):

cd your/prefered/folder
git clone https://pss-gitlab.math.univ-paris-diderot.fr/data-processing-wg/seisglitch.git

  1. Go in the seisglitch folder and install it via pip (on Windows, you may need to install “pip” first):

    cd seisglitch
pip install .

Good news, everything is installed and ready to use! Remember to activate the seisglitch environment each time you want to use it, i.e., conda activate seisglitch. The package should be available from all paths in your system. You can check the seisglitch version you have installed via:

seisglitch -v

The most recent version is 1.0.1.

If you’d like to introduce your own changes to the code, you may want to replace step 4 by:

  1. Install seisglitch:

    pip install -e .

thus installing the package in editable mode, avoiding having to re-install after any code alteration.

Update / Upgrade

If you already have seisglitch installed and just would like to get the newest version, simply:

Open a terminal (Windows: Anaconda powershell) and type:

conda activate seisglitch
cd your/seisglitch/folder  # see Installation
git pull
pip install .              # (or pip install -e .)

If you are aiming only for the potentially updated MATLAB files or more recent versions of deglitched data, you just need to do:

cd your/seisglitch/folder  # see Installation
git pull