Welcome to HyFI’s documentation!

HyFI (Hypocenter-based 3D Imaging of Active Faults) is a Python package for imaging active faults in 3D based on relatively relocated hypocenter datasets.

Scientific Publication

If you use the code in this repository please cite the following scientific publication:

Truttmann, S., Diehl, T., Herwegh, M. (2023). Hypocenter-based 3D Imaging of Active Faults: Method and Applications in the Southwestern Swiss Alps. Journal of Geophysical Research: Solid Earth. https://doi.org/10.1029/2023JB026352

Getting Started

• Installation Guide
  • Step 1: Install Miniforge (Mamba Package Manager)
  • Step 2: Download HyFI
  • Step 3: Create the Mamba Environment
  • Step 4: Install HyFI
  • Step 5: Verify Installation
  • Step 6: Install ParaView (Optional, for 3D Visualization)
  • Next Steps
• Quickstart
  • Prerequisites
  • Running Your First Analysis
  • Using Your Own Data
  • Next Steps

User Guide

• HyFI Processing Workflows
  • Single-Sequence Processing
    • When to Use Single-Sequence Processing
    • Configuration Structure
    • Running Single-Sequence Analysis
  • Multi-Sequence Processing
    • When to Use Multi-Sequence Processing
    • Multi-Sequence Processing Explained
    • Configuration Structure
    • Running Multi-Sequence Analysis
• HyFI Configuration
  • Configuration File Structure
  • Single-Sequence DAG Configuration
    • Main Sections
    • Minimal Configuration Example
  • Multi-Sequence DAG Configuration
    • Main Sections
    • Minimal Configuration Example
  • Complete Parameter Reference
• HyFI Input Parameters
  • Table of Contents
  • Metadata
  • Global Settings
    • Common Settings (Single & Multi-Sequence)
    • Multi-Sequence Only Settings
  • Input Data
    • File Requirements
    • Required Hypocenter Columns
    • Required Focal Mechanism Columns (Optional)
    • Data Source Conversions
    • CSV Example
    • Data Validation
  • Fault Network
    • Core Network Parameters
    • Outlier Detection
    • Focal Mechanism Constraints
    • Automatic Parameter Optimization
  • Model Validation
    • Validation Parameters
  • Auto Classification
    • Orientation Clustering Parameters
    • Spatial Sub-Clustering Parameters
  • Stress Analysis
    • Regional Stress Field Parameters
    • Mechanical Properties Parameters
  • Visualization
    • Basic Visualization Parameters
    • Fault Surface Interpolation Parameters
    • 3D Export Parameters
  • Multi-Sequence Processing
    • Step 1: Load Input Data
    • Step 2: Segmentation Configuration
    • Step 3: Per-Sequence Analysis Configuration
    • Step 4: Merge and Export Configuration
• HyFI Core Modules
  • Core Module Execution Order
  • Core Analysis Modules
    • Fault Network Reconstruction
    • Model Validation
    • Automatic Classification
    • Stress Analysis
    • Visualization
• HyFI Terminology
• HyFI Output
  • Single-Sequence Output Structure
  • Multi-Sequence Output Structure

Examples

• Single-Sequence Examples
• Multi-Sequence Examples

API Reference

• API Reference

Additional Resources

• License

Indices and tables

• Index

• Module Index

• Processing Workflow: Understand the different processing workflows of HyFI to analyze simple or more complex earthquake catalogs

• Configuration Guide: Learn how to set up JSON configuration files for your analysis

• Input Parameters: Detailed documentation of all configuration parameters, including data source conversion

• HyFI Modules: Understand the different analysis modules (fault network, validation, classification, stress analysis)

• Output Guide: Learn about the generated output files and visualizations

• Examples: Explore example projects and use cases

---

Happy fault imaging! 🎉