Skip to content

ChengshunShang1996/FastSlipPy

Repository files navigation

FastSlipPy: Induced Seismic Fault Slip Modeling

Release License Contributing

Dynamic fault slip modeling software in induced seismicity. This code aims to ...

The initial version of this software is based on the open-source code IndNuc.

Table of Contents

Main Features

This program can be used for ...

  • It provides a ...

Dependencies

FastSlipPy is fully written in the Python programming language and adopts the Object Oriented Programming (OOP) paradigm to offer modularity and extensibility. Due to the nature of Python, this program can be run on different platforms (Windows or Linux)

Please make sure you have installed Python3.X.X on your PC. Currently, Python3.10.X is recommended, as other versions haven't been tested.

Required Python Pakage:

  • numpy
  • matplotlib

Instructions

Install

Download this software or use Git:

git clone https://github.com/ChengshunShang1996/FastSlipPy.git

Then, in the project folder, run cmd command:

pip install -e .

Test it:

from fastslippy import FastSlipPy

If you see the logo, you have successfully installed it.

Input and Output Files

  • Input Parameters (.json):

This JSON file is used as input for the program. For generating particle packings, at least one input file is needed: [ParametersDEMGen.json][ParametersDEMGen_link].

Running Simulations

To run a simulation, launch the ...

Examples

Examples are available inside the folder examples.

Documentation

Please read this README.md for information.

How to Contribute

Please check the contribution guidelines.

How to Cite

To cite this repository, you can use the metadata from this file.

Authorship

1 Utrecht University (UU)

Acknowledgement

The program was initially developed under the context of the FastSlip project.

License

FastSlipPy is licensed under the MIT license, which allows the program to be freely used by anyone for modification, private use, commercial use, and distribution, only requiring the preservation of copyright and license notices. No liability and warranty are provided.

About

Dynamic fault slip modeling software in induced seismicity.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages