Skip to main content

OpenTimsTDF

CI DOI crates.io PyPI docs.rs License: Apache-2.0 Rust MSRV

Part of the OpenMassSpec stack for mass spectrometry raw-file access.

Rust and Python reader for timsTOF .d/ (TDF) acquisition bundles - the SQLite analysis.tdf metadata file and the analysis.tdf_bin binary frame stream. Runs on Linux, macOS, and Windows.

Documentation: sigilweaver.app/opentimstdf/docs

Install

Prefer openmassspec-io with the bruker feature/extra unless you need this parser standalone (minimal dependencies, or building your own abstraction) - the umbrella gives you format auto-detection, mzML conversion, and Arrow streaming across all wired-in vendors for free:

cargo add openmassspec-io --features bruker
pip install openmassspec[bruker]

Standalone:

Rust:

cargo add opentimstdf

Python:

pip install opentimstdf

Quickstart

Rust:

use opentimstdf::Reader;

let reader = Reader::open("my_bundle.d")?;
let calib = reader.calibration()?;
let frame = reader.frame(1)?;
for peak in reader.decode_peaks(&frame)? {
    let mz = calib.tof_to_mz(peak.tof);
    let im = calib.scan_to_inv_mobility(peak.scan);
    println!("scan={} mz={:.4} 1/K0={:.4} i={}", peak.scan, mz, im, peak.intensity);
}

Python:

import opentimstdf

reader = opentimstdf.Reader("my_bundle.d")
calib = reader.calibration()
frame = reader.frame(1)
for peak in reader.decode_peaks(frame):
    mz = calib.tof_to_mz(peak.tof)
    print(peak.scan, mz, peak.intensity)

See the docs site for the full quickstart, guide, and format specification.

License

Apache-2.0. See LICENSE.

The TDF format and codecs were worked out from public sample data (PRIDE accessions). See ATTRIBUTION.md.

Download files

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

Source Distribution

opentimstdf-1.3.1.tar.gz (47.2 kB view details)

Uploaded Source

Built Distributions

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

opentimstdf-1.3.1-cp38-abi3-win_amd64.whl (1.3 MB view details)

Uploaded CPython 3.8+Windows x86-64

opentimstdf-1.3.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.6 MB view details)

Uploaded CPython 3.8+manylinux: glibc 2.17+ x86-64

opentimstdf-1.3.1-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (1.4 MB view details)

Uploaded CPython 3.8+manylinux: glibc 2.17+ ARM64

opentimstdf-1.3.1-cp38-abi3-macosx_11_0_arm64.whl (1.4 MB view details)

Uploaded CPython 3.8+macOS 11.0+ ARM64

opentimstdf-1.3.1-cp38-abi3-macosx_10_12_x86_64.whl (1.5 MB view details)

Uploaded CPython 3.8+macOS 10.12+ x86-64

File details

Details for the file opentimstdf-1.3.1.tar.gz.

File metadata

  • Download URL: opentimstdf-1.3.1.tar.gz
  • Upload date:
  • Size: 47.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for opentimstdf-1.3.1.tar.gz
Algorithm Hash digest
SHA256 5e987ec57d4234feb44ae28fab1f7bc732e9ad7aa0afb031d8926c3b62d5bc4b
MD5 56f85114172c7c314fc69eca51db5ff6
BLAKE2b-256 ce99b5afc0f2947e4bcba33484d7fa66b59b7682b6d24ac0bd4ec8228d419c0d

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentimstdf-1.3.1.tar.gz:

Publisher: publish.yml on Sigilweaver/OpenTimsTDF

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file opentimstdf-1.3.1-cp38-abi3-win_amd64.whl.

File metadata

  • Download URL: opentimstdf-1.3.1-cp38-abi3-win_amd64.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: CPython 3.8+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for opentimstdf-1.3.1-cp38-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 b8be5b2f031f9e0181cf61ea1a164933824a22d0b55d9e49f57f0c05be24193e
MD5 570625d52123b0300fc9d5ff988ddafa
BLAKE2b-256 2ec6f5aa65dbfe8ad7efb2f5ecf0fa124a6f8eff9b6b2e7f640ff2bfb1b149c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentimstdf-1.3.1-cp38-abi3-win_amd64.whl:

Publisher: publish.yml on Sigilweaver/OpenTimsTDF

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file opentimstdf-1.3.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for opentimstdf-1.3.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a7bdde25ec6424b33c6f86116bcb0d84aa4be81125a4a6af00dc244ac3dba31b
MD5 00376c2283ab5140dc607b7971d5925a
BLAKE2b-256 b4cd7de62ea81bd8490404654bf540e1a49aaec4a028e75f35a6f8259d6bb1b9

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentimstdf-1.3.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: publish.yml on Sigilweaver/OpenTimsTDF

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file opentimstdf-1.3.1-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for opentimstdf-1.3.1-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 cc2378dd44cc1172d521c565d22fbf5b239ee4acba4892a5c351d346aaaa843c
MD5 10819598f085f131bf5d0ef52d211daf
BLAKE2b-256 26dd82e4a2d8dabe9f3a5f893c6b6d2c78e20977dab8fc3ae5736946579a2812

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentimstdf-1.3.1-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: publish.yml on Sigilweaver/OpenTimsTDF

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file opentimstdf-1.3.1-cp38-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for opentimstdf-1.3.1-cp38-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 bf887d9bb7d1eaaff6e8da643eb58fdd62b6f90787733e9f7e63ca0e422bc1ce
MD5 cb1fdfeb59cd66d2ef71ffc305afab50
BLAKE2b-256 89393f743b2bda6cd7a715123999f3c82e3324b26cb751fbdd5526153482995b

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentimstdf-1.3.1-cp38-abi3-macosx_11_0_arm64.whl:

Publisher: publish.yml on Sigilweaver/OpenTimsTDF

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file opentimstdf-1.3.1-cp38-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for opentimstdf-1.3.1-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 4fd80235a576cb4806f4e9e97915a4bcfd196a7d5580059201f95e1edab8f7ca
MD5 859ede0a332c912d9feddb43e4aefce6
BLAKE2b-256 45f976efb9924f96081076550256d20d50d8e127855ca0eb4a653f43412cf86c

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentimstdf-1.3.1-cp38-abi3-macosx_10_12_x86_64.whl:

Publisher: publish.yml on Sigilweaver/OpenTimsTDF

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.3.3

6 files

1.3.2

6 files

This release

1.3.1 This release

6 files

1.3.0

6 files

1.2.6

6 files

1.2.5

6 files

1.2.4

6 files

1.2.3

6 files

1.2.0

6 files

1.1.0

6 files

1.0.6

6 files

1.0.5

6 files

1.0.4

6 files

1.0.3

6 files

1.0.1

6 files

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