A program for texture simulations.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for poautran from gravatar.com poautran Avatar for textom from gravatar.com textom

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: MIT
    SPDX License Expression
  • Author: Moritz Frewein, Marc Allain, Tilman Gruenewald
  • Maintainer:
  • Requires: Python <3.14, >=3.9
  • Provides-Extra: test , docs
Classifiers
Report project as malware

Project description

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)

Recommended (conda/micromamba environment + pip)

conda create --name textom python=3.11
conda activate textom
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.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for poautran from gravatar.com poautran Avatar for textom from gravatar.com textom

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: MIT
    SPDX License Expression
  • Author: Moritz Frewein, Marc Allain, Tilman Gruenewald
  • Maintainer:
  • Requires: Python <3.14, >=3.9
  • Provides-Extra: test , docs
Classifiers

Release history Release notifications | RSS feed

This version

0.7.19

0.7.18

0.7.17

0.7.16

0.7.15

0.7.14

0.7.13

0.7.12

0.7.11

0.7.10

0.7.9

0.7.8

0.7.7

0.7.6

0.7.5

0.7.3

0.7.2

0.7.0

0.6.16

0.6.15

0.6.14

0.6.13

0.6.12

0.6.11

0.6.10

0.6.9

0.6.8

0.6.7

0.6.6

0.6.5

0.6.4

0.6.3

0.6.2

0.6.1

0.6.0

0.5.10

0.5.9

0.5.8

0.5.7

0.5.6

0.5.5

0.5.4

0.5.3

0.5.2

0.5.1

0.5.0

0.4.16

0.4.15

0.4.14

0.4.13

0.4.12

0.4.11

0.4.10

0.4.9

0.4.8

0.4.7

0.4.6

0.4.5

0.4.4

0.4.3

0.4.2

0.4.1 yanked

Reason this release was yanked:

not stable

0.4.0 yanked

Reason this release was yanked:

experimental new features

0.3.10

0.3.9

0.3.8

0.3.7

0.3.6

0.3.5

0.3.4

0.3.3

0.3.2

0.3.1

0.3.0

0.2.13

0.2.12

0.2.11

0.2.10

0.2.9

0.2.8

0.2.7

0.2.6

0.2.5

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.33

0.1.32

0.1.31

0.1.30

0.1.29

0.1.28

0.1.27

0.1.26

0.1.25

0.1.24

0.1.23

0.1.22

0.1.21

0.1.20

0.1.19

0.1.18

0.1.17

0.1.16

0.1.15

0.1.14

0.1.13

0.1.12

0.1.11

0.1.10

0.1.9

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.1

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

textom-0.7.19.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

textom-0.7.19-py3-none-any.whl (1.8 MB view details)

Uploaded Python 3

File details

Details for the file textom-0.7.19.tar.gz.

File metadata

  • Download URL: textom-0.7.19.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for textom-0.7.19.tar.gz
Algorithm Hash digest
SHA256 827ffcc2008e844c61e875262fbd46e54c05cdf5ef0f547b2c5268f1b2e2e668
MD5 7cb022d50ab4f0ffc24cd728964a87b8
BLAKE2b-256 c0c3f9484a0f12f5eeefd3624be99570b9b6dab9662934889a124799826fefed

See more details on using hashes here.

File details

Details for the file textom-0.7.19-py3-none-any.whl.

File metadata

  • Download URL: textom-0.7.19-py3-none-any.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for textom-0.7.19-py3-none-any.whl
Algorithm Hash digest
SHA256 96f911edafd9a2da7946bb0699f090dc43d3e4e22e5020be2ce900d065f1525a
MD5 82cbe6b92c6930a276ad247e6754f6aa
BLAKE2b-256 9f47cc074579a497e7c6f7c061cec498715d38b10402cc48a3a5b79c8773c67c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page