Skip to main content

TexTOM

TexTOM is an end-to-end Python toolbox for texture tomography, covering:

  • detector-frame integration (pyFAI),
  • projection alignment (Mumott-based workflows),
  • physical model generation (diffractlets + projectors),
  • orientation-distribution optimization,
  • post-analysis and visualization.

Documentation

Installation

Requirements

  • Python >=3.9,<3.14
  • Linux/macOS (scientific stack availability may vary by platform)
conda create --name textom python=3.11
conda activate textom
conda install numpy=2.4 scipy=1.16 openblas
python -m pip install --upgrade pip
python -m pip install textom

From source (development)

git clone https://gitlab.fresnel.fr/textom/textom.git
cd textom
python -m pip install -e ".[test,docs]"

Command-line entry points

After installation:

  • textom: launches an IPython session with TexTOM API preloaded.
  • textom_config: opens textom/config.py for runtime defaults.
  • textom_documentation: opens the legacy PDF manual.

Quickstart

Inside a sample working directory:

textom

Then in the IPython session:

set_path(".")
check_state()
integrate()
align_data()
make_model()
preprocess_data()
optimize()

Typical outputs are created under:

  • analysis/ (intermediate products, models, fits),
  • data_integrated/ and optionally data_integrated_1d/,
  • results/ (derived metrics and exported artifacts).

For a complete walkthrough, follow:

  • docs/tutorials/workflow.md
  • docs/how_to_guides/setup.md
  • docs/how_to_guides/remote.md

Configuration

Use:

textom_config

Key runtime parameters in textom/config.py include thread count, GPU usage, numerical dtype, and UI behavior. Keep project-specific configs versioned when running in teams or CI.

Development

Run tests:

pytest textom/tests

Run style checks:

isort --profile black --check-only --diff textom
ruff check .
ruff format --check .

Build docs:

sphinx-build -b html docs public

Citation

If you use TexTOM in published work, cite:

Frewein, M. P. K., Mason, J., Maier, B., Colfen, H., Medjahed, A., Burghammer, M., Allain, M. & Grunewald, T. A. (2024). IUCrJ, 11, 809-820. https://doi.org/10.1107/S2052252524006547

License

MIT License. See LICENSE.

Metadata

Release files for TexTOM 0.7.21

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for TexTOM 0.7.21
File Size Uploaded Provenance Actions
textom-0.7.21.tar.gz 2.2 MB Without provenance Details for textom-0.7.21.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for TexTOM 0.7.21
File Interpreter ABI Platform Actions
textom-0.7.21-py3-none-any.whl Python 3 none any Details for textom-0.7.21-py3-none-any.whl

Total release size: 4.5 MB

Release files / textom-0.7.21.tar.gz

Download URL textom-0.7.21.tar.gz
Size 2.2 MB
Tags Source
SHA-256 checksum
How to use checksums
b5aea2bd024de40ee1e315a5e0d9c93b35d9aec02763275ef443725ff7314b0f
BLAKE2b-256 checksum
How to use checksums
51a093ca2bd2a62faa237a0bc29278758691950afa606ecb7337f0d01f6593d7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Release files / textom-0.7.21-py3-none-any.whl

Download URL textom-0.7.21-py3-none-any.whl
Size 2.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
094f129ab28d307f4ac15b8ca8d48053c4a86b86149700b960222e328edadb93
BLAKE2b-256 checksum
How to use checksums
83ebac5d9ce5ad53b51f1d60c88544d9192f0db3e0d62bca512353560910235a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Security for TexTOM 0.7.21

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.7.21 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page