TexTOM Documentation

Welcome to the web documentation for TexTOM. Unlike the printable PDF manual, this site is organised into topic-focused sections that you can browse or deep-link. Start with the overview, then branch out to tutorials, how-to guides, background explanations, and generated API references.

Start Here

• TexTOM Overview
  • Key Capabilities
  • Command-Line Entry Points
  • Documentation Layout
• Full Workflow Tutorial
  • 1. Prepare the Sample Directory
  • 2. Integrate Raw Frames
  • 3. Align Projections
  • 4. Build the Physical Model
  • 5. Pre-process Peaks
  • 6. Optimise Orientation Distributions
  • 7. Analyse and Export Results
  • 8. Visualise
  • Next Steps
• Environment and Configuration
  • 1. Create a Clean Environment
  • 2. Optional Dependencies
  • 3. Configure TexTOM Defaults
  • 4. Project Layout Checklist
  • 5. Keeping Environments in CI
  • Troubleshooting
• Remote and Batch Usage
  • SSH Sessions
  • Headless / Batch Runs
  • Resource Management
  • Recovering from Interruptions
  • CI / Automation
• Under the Hood
  • Diffractlets
  • Projectors
  • Optimisation Loop
  • Orientation Statistics
  • Visualisation Pipeline
• API Reference
  • Core Modules

Getting Around

• Use the Tutorial to walk through a full reconstruction on new data.

• Consult How-to Guides for specific tasks (environment prep, remote usage, troubleshooting).

• Visit Explanations when you need theory or parameter intuition.

• Jump into References for autodoc-generated API pages covering TexTOM modules.

The legacy LaTeX/PDF manual (with a more detailled walkthrough and screenshots) remains available through typing textom_documentation.