---
title: TexTOM Documentation
---

# TexTOM Documentation

Welcome to the web documentation for TexTOM. Unlike the [printable PDF manual](https://gitlab.fresnel.fr/textom/textom/-/raw/main/textom/documentation/textom_documentation.pdf?ref_type=heads&inline=false), 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.

```{toctree}
:maxdepth: 2
:caption: Start Here

overview
tutorials/workflow
how_to_guides/setup
how_to_guides/remote
explanation/background
references/api
```

## 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`.