Welcome to Nexus-CAT’s Documentation!

Contents

• Introduction
  • Project Goals
• Installation
  • Prerequisites
  • Installation Steps
• Getting Started
  • Quick Start Example
  • Workflow Overview
  • Frame Processing Loop
  • Output Files
  • Key Design Features
• Features
  • Cluster Analysis
  • Percolation Properties
  • Extensibility
  • Visualization and Output
• Usage Examples
  • Example 1: Silica Analysis with Coordination Strategy
  • Example 2: Reconfiguring and Rerunning with Shared Neighbors
  • Example 3: Distance-Based Clustering
  • Example 4: Custom Lattice Configuration
• API Reference
  • main.py
  • config Module (Settings)
  • core Module
  • analysis Module
  • Parser module (io module)
  • Writer module (io module)
  • Reader module (io module)
  • utils Module
• Contributing
  • Development Setup
• License