seismogen

A Python package for earthquake generation.

This project is developed in collaboration with the Centre for Advanced Research Computing, University College London.

About

Project team

• Devaraj Gopinathan (Devaraj-G)
• Dimitra Salmanidou (dimitrasal)
• Matt Graham (matt-graham)

Getting started

Pre-requisites

seismogen requires Python 3.10–3.12.

Installation

We recommend installing in a project specific virtual environment created using a environment management tool such as Conda. To install the latest development version of seismogen using pip in the currently active environment run

pip install git+https://github.com/UCL-ARC/seismogen.git

Alternatively create a local clone of the repository with

git clone https://github.com/UCL-ARC/seismogen.git

and then install in editable mode by running

pip install -e .

Running tests

Tests can be run across all compatible Python versions in isolated environments using tox by running

tox

To run tests manually in a Python environment with pytest installed run

pytest tests

again from the root of the repository.

Building documentation

The MkDocs HTML documentation can be built locally by running

tox -e docs

from the root of the repository. The built documentation will be written to site.

Alternatively to build and preview the documentation locally, in a Python environment with the optional docs dependencies installed, run

mkdocs serve