TranCIT: Transient Causal Interaction Toolbox

Getting Started

  • Installation
    • Prerequisites
    • Install from PyPI
    • Install from Source
    • Verify Installation
    • Optional Dependencies
  • Quickstart
    • Installation Check
    • Basic Causality Analysis
    • Pipeline-Based Event Analysis
    • Different Types of Analysis
    • Working with Real Data
    • Common Troubleshooting
    • What’s Next?
  • Tutorials
    • Tutorial 1: Basic DCS Analysis
      • Understanding the Data Format
      • Step-by-Step DCS Analysis
      • Visualizing Results
    • Tutorial 2: Event-Based Analysis with Pipeline
      • Understanding Event Detection
      • Configuring the Pipeline
      • Running the Event-Based Analysis
      • Visualizing Event-Based Results
    • Tutorial 3: Advanced Configuration and Optimization
      • Model Order Selection
      • Handling Different Data Types
      • Performance Optimization
      • Statistical Validation
    • Tutorial 4: Real-World Applications
      • Neural Data Analysis
      • Economic Time Series Analysis
      • Multi-Scale Analysis
    • Tutorial 5: Best Practices and Troubleshooting
      • Data Quality Assessment
      • Robust Analysis Pipeline
      • Common Issues and Solutions
      • Performance Monitoring

User Guide

  • Examples
    • Basic Usage Script
    • Reproducing a Scientific Figure (Jupyter Notebook)
    • Advanced Pipeline Example
    • More Coming Soon!
  • API Reference
    • Core Module (trancit.core)
      • Base Classes
      • Exception Classes
    • Causality Analysis (trancit.causality)
      • Dynamic Causal Strength (DCS)
      • Transfer Entropy
      • Granger Causality
      • Relative Dynamic Causal Strength (rDCS)
      • Utility Functions
    • Pipeline System (trancit.pipeline)
      • Pipeline Orchestration
      • Pipeline Stages
    • Configuration (trancit.config)
      • Main Configuration
      • Parameter Classes
    • Model Estimation (trancit.models)
      • VAR Model Estimation
      • BIC Model Selection
      • Model Validation
    • Simulation (trancit.simulation)
      • Signal Generation
      • AR Event Simulation
      • VAR Simulation
    • Utilities (trancit.utils)
      • Data Processing
      • Core Analysis Functions
      • Signal Processing
      • Residual Analysis
      • Visualization
      • Helper Functions
    • Complete Usage Examples
      • Basic Analysis Workflow
      • Event-Based Analysis Workflow
    • Performance Notes
    • Troubleshooting
  • Event Detection Preprocessing Pipeline
    • Overview
    • Preprocessing Stages
      • 1. Event Detection
      • 2. Border Removal
      • 3. Snapshot Extraction
      • 4. Artifact Rejection
      • 5. Statistics Computation
    • Software Architecture
      • Pipeline Design Pattern
      • State Management
    • API Design
      • Configuration-Driven Architecture
      • User Interface
      • Configuration Flexibility
    • Implementation Details
      • Event Detection Algorithm
      • Snapshot Extraction Details
      • Error Handling
    • Integration with Causality Analysis
    • References
  • Software Architecture
    • Package Structure
      • Core Module (trancit.core)
      • Causality Module (trancit.causality)
      • Pipeline Module (trancit.pipeline)
      • Models Module (trancit.models)
      • Simulation Module (trancit.simulation)
      • Utilities Module (trancit.utils)
    • Dependencies
      • Core Dependencies
    • Design Choices
      • Configuration-Driven Architecture
      • Extensibility Through Abstract Base Classes
      • Comprehensive Error Handling
      • Reproducibility and Logging
    • Testing and Quality Assurance
    • Performance Considerations
    • Version Management

Community & Legal

  • Contributing
    • TL;DR - How to Contribute
    • Reporting Issues
    • Feature Requests
    • Contributing Code
    • More Guidelines
  • License
TranCIT: Transient Causal Interaction Toolbox
  • Overview: module code

All modules for which code is available

  • trancit.causality.dcs
  • trancit.causality.granger
  • trancit.causality.rdcs
  • trancit.causality.transfer_entropy
  • trancit.config
  • trancit.core.base
  • trancit.core.exceptions
  • trancit.models.bic_selection
  • trancit.models.model_validation
  • trancit.models.var_estimation
  • trancit.pipeline.orchestrator
  • trancit.pipeline.stages
  • trancit.simulation.ar_simulation
  • trancit.simulation.oscillator_simulation
  • trancit.simulation.var_simulation
  • trancit.utils.core
  • trancit.utils.preprocess
  • trancit.utils.residuals
  • trancit.utils.signal

© Copyright 2025, Salar Nouri / CMC-Lab.

Built with Sphinx using a theme provided by Read the Docs.