fracspy 0.1.0

A python package for general microseismic modelling, monitoring and analysis

FraCSPy

FraCSPy stands for Python Framework for Conventional microSeismic Processing.

It is a single python toolbox for the full microseismic pipeline from modelling to post-event analysis. This library is a single location leveraging the excellent work of other scientists (software developers) and adapts them for the specific use case of microseismic monitoring.

Some functionalities include:

• modelling script generation (for accompanying SOFI3D)
• event imaging: detection, location
• moment tensor inversion

Some python libraries that are utilised include:

• pylops
• torch
• obspy
• and more...

Requirements

Installation requires either pip package installer or Conda package manager, e.g. one can use miniforge.

Install using pip

pip install fracspy

Install using conda

Linux

Simply run

make install

It will create a new conda environment fracspy with all the required packages:

Similarly, on Linux you can run:

./install.sh

Windows

On Windows, the best way is to use miniforge prompt and run:

install.bat

It will install the package to environment fracspy and activate it.

To install development version use

install-dev.bat

Now you are ready to use the package.

Uninstall

If you need to add/change packages:

conda deactivate
conda remove -n fracspy -all

Documentation

The latest stable documentation based on Sphinx is available online at: https://fracspy.github.io/FraCSPy

One can also build the documentation locally:

cd docs
make html

If you want to rebuild the documentation:

make clean
make html

After a successful build, one can serve the documentation website locally:

cd build/html
python -m http.server

and open in browser: http://localhost:8000

To build/rebuild documentation on Windows you can simply run

build_docs.bat

Note: check the exact port number in the output