thilowrona / fatbox

A python module for the analysis of faults in raster data

Fault analysis toolbox

A python module for the extraction and analysis of faults (and fractures) in raster data. We often observer faults in 2-D or 3-D raster data (e.g. geological maps, numerical models or seismic volumes), yet the extraction of these structures still requires large amounts of our time. The aim of this module is to reduce this time by providing a set of functions, which can perform many of the steps required for the extraction and analysis of fault systems.

The basic idea of the module is to describe fault systems as graphs (or networks) consisting of nodes and edges, which allows us to define faults as components, i.e. sets of nodes connected by edges, of a graph. Nodes, which are not connected through edges, thus belong to different components (faults).

Getting started

Tutorials

If you wanna get started, we highly recommend checking out some of our tutorials as well as our documentation

Your own machine

Linux

You can also use the fault analysis toolbox on your own machine. All you need is a Python 3 enviromnent and git, then you can install the toolbox:

pip3 install git+https://github.com/thilowrona/fatbox.git

Windows

In windows, I've had problems installing the package cv_algorithms. When that happens, you can clone this repo:

git clone https://github.com/thilowrona/fatbox

Go to the file: '/fatbox/fatbox/preprocessing.py' and comment this line:

# import cv_algorithms

as well as the entire function skeleton_guo_hall (which uses cv_algorithms). Next you need to tell pip not to install cv_algorithms. You can do this by deleting the associated lines in the files: anaconda_requirements.txt, pip_requirements.txt and setup.cfg located in '/fatbox'.

Now you can install fatbox from outside your local directory '/fatbox':

pip3 install -e /fatbox

Check

Now you can load any function from the toolbox in Python:

from fatbox.plots import plot_attribute

You can also clone the companion git repository containing the tutorials:

git clone https://github.com/thilowrona/fatbox_tutorials

License

Copyright [2022] Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Citation

If you use this project in your research or wish to refer to the results of the tutorials, please use the following BibTeX entry.

@misc{fatbox2021,
  author =       {Thilo Wrona, Sascha Brune, Pauline Gayrin, Tim Hake},
  title =        {{Fault analysis toolbox}},
  howpublished = {\url{https://doi.org/10.5880/GFZ.2.5.2022.002}},
  year =         {2022}
}

fatbox's Issues

Is there any principle introduction?

Fatbox is a good tool for the automatic calculation of the fault network. But I cannot find any information about it's principle. Would you please tell me it's reference ?
Regards,
Li Jian