Installation

This guide explains how to install ShakeLab, either as a user who simply wants to run the software, or as a developer who plans to contribute or experiment with the source code.

Depending on your needs, you can install ShakeLab using pip from PyPI, directly from the GitHub repository, or from a locally cloned version in editable mode.

Standard Installation from PyPI

The easiest way to install ShakeLab is from the Python Package Index (PyPI):

Bash Copy

pip install shakelab

or, explicitly using Python 3:

Bash Copy

pip3 install shakelab

Warning

The version available on PyPI may not include the latest features and fixes, as the code is under active development. If you want the most up-to-date version, consider using one of the installation methods below.

Installation from GitHub (latest code)

You can install the most recent version of ShakeLab directly from GitHub:

Bash Copy

pip install git+https://github.com/shakelab/shakelab.git

To upgrade:

Bash Copy

pip install --upgrade git+https://github.com/shakelab/shakelab.git

Developer Installation from a Local Repository

If you wish to modify the code or contribute to the project:

Bash Copy

git clone https://github.com/shakelab/shakelab.git
cd shakelab
pip install -r requirements.txt -e .

This will install the package in “editable” mode, so changes to the source code will be immediately reflected.

Optionally, you can create and activate a virtual environment before installing:

Bash Copy

python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Requirements

ShakeLab requires Python 3.7 or higher.

The following Python packages are required:

• numpy >= 1.24.0

• scipy >= 1.10.0

• shapely >= 2.0.0

• requests >= 2.32.0

• cymseed3 >= 0.1.4

These dependencies are automatically installed when using pip.