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.3.tar.gz (54.3 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.3-cp38-abi3-win_amd64.whl (1.3 MB view details)

Uploaded CPython 3.8+Windows x86-64

opentimstdf-1.3.3-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.3-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.3-cp38-abi3-macosx_11_0_arm64.whl (1.4 MB view details)

Uploaded CPython 3.8+macOS 11.0+ ARM64

opentimstdf-1.3.3-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.3.tar.gz.

File metadata

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

File hashes

Hashes for opentimstdf-1.3.3.tar.gz
Algorithm Hash digest
SHA256 8823c9812a49f2efb19dd30381eaef6d2dae9f49e6bcdcb195998acdcfaeedc4
MD5 bff448d82f24f104fce58b00bc94994a
BLAKE2b-256 a521a8f56d8afad12cd5975d6c7e8d109963c55a01d02a3b9265fda2ee5d4dab

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentimstdf-1.3.3.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.3-cp38-abi3-win_amd64.whl.

File metadata

  • Download URL: opentimstdf-1.3.3-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/7.0.0 CPython/3.13.14

File hashes

Hashes for opentimstdf-1.3.3-cp38-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 ec14cd6bf7cac86df8e4404edcdc902176297d5b1463de56a885fffa210649cf
MD5 35b5902bf00bf4716b6a574a8b5b06ab
BLAKE2b-256 2c3ee13e5e3f99477ac77bf7012e529087ad2b942c8e1cb766d95de9c4f9e9d5

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentimstdf-1.3.3-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.3-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for opentimstdf-1.3.3-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 63b1d750feb22611665499ea72215d37bcebf830e63648804b0d078a3a2e0fcb
MD5 7990ee687a16ca99a9e94c54e1b91814
BLAKE2b-256 9280f470f5517b6012d145526a5a03d78bedd9342c240e2307967e9b4d934e41

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentimstdf-1.3.3-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.3-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for opentimstdf-1.3.3-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 e7524ad74a974d5e23eb3b7984e9820e7058528772b2c203150299883880b61f
MD5 f56b57650759acc2fb7a150b41932399
BLAKE2b-256 1b9b7a3a1e2146f1c87be588bfc0cdd8c0acac5f3b31ce6e960e77e2b4cbe9dc

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentimstdf-1.3.3-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.3-cp38-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for opentimstdf-1.3.3-cp38-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 8146f865fa39397aed30347687d58869ca8abf2dffddf37afd9f5cc66519a49e
MD5 ac6caf95f055f61c56e73586a28e0b10
BLAKE2b-256 158fc6cec4697915d6d685aed7f4ab3a0310fcc2c1512dfc9875f7c25bac1ec5

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentimstdf-1.3.3-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.3-cp38-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for opentimstdf-1.3.3-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 3f1a1f34e603f145bd45658f4bdd6c08f52518f7b965f9437e18077355d9a4ec
MD5 d0183496f56f67ce0aa0cd01ac55bd4f
BLAKE2b-256 003e434361479f284f4bbaa77a0f53910334dc3de551b415f185ba3f1fc2d7fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentimstdf-1.3.3-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

This release

1.3.3 This release

6 files

1.3.2

6 files

1.3.1

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