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. Sibling readers: OpenWRaw (Waters), OpenTFRaw (Thermo).

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

Uploaded CPython 3.8+Windows x86-64

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

Uploaded CPython 3.8+macOS 11.0+ ARM64

opentimstdf-1.2.5-cp38-abi3-macosx_10_12_x86_64.whl (1.4 MB view details)

Uploaded CPython 3.8+macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for opentimstdf-1.2.5.tar.gz
Algorithm Hash digest
SHA256 e5b98753adc28010ebcab49f5d05fbec557fe901965c7e2e7ed3cf72708e0a91
MD5 f56f0e8c84f56938bde482e483699f30
BLAKE2b-256 8f949046dd3ebc5004d39600d57386a2286cb482b732270a2919a15ba2c3f8c9

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: opentimstdf-1.2.5-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.12

File hashes

Hashes for opentimstdf-1.2.5-cp38-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 7bda5c84f420e3767b080f5245625a98cb7f499fdddd7fabef02b6b5bd046d55
MD5 1a08f6e61de546d5e47d9f757a01f292
BLAKE2b-256 5d3e202a51a72490c75e334a0c004511deab863526286a5079a6686253647502

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.2.5-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 07c1074955a81964449908dbc8893c6b97c40c84a569ef4c35db7f6212641e69
MD5 432c413c02d14f729d8647125cc8617e
BLAKE2b-256 a447e823a41bc9155d5d46258878159a70bbec5f2c9e5f2d72ba7a0ecdd1d202

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.2.5-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 643fa306b7fad3cbfd7a8821e27c70314553b38bead604e32a05038b265614ab
MD5 cfb7a98cd77423a779928e7884f8bd0d
BLAKE2b-256 44e40e6ad7045d76da0189ab3400bab8347e48ac18154e1a48fb07cb0e74a9ad

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.2.5-cp38-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 6d102a8576e883bcb4efd526c5f03d1d918a09cee4745122b08c470a53cc02ca
MD5 38697d168d7a09a4ba726b68393b56be
BLAKE2b-256 914d75e39a0cf613d0370385849eb1a39c507a8fd3ff6068936a0501b115d092

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.2.5-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 3caed8367186890320906b52720313858c861ba56b3f0281d96bdd3f61c84130
MD5 10b52426f6d1e7d4b6802ad8cf91bba3
BLAKE2b-256 e93f9d37f20467d16954d34efc0db8ca26458687c6fb4db7fa9c2a3ac8fb5522

See more details on using hashes here.

Provenance

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

1.3.1

6 files

1.3.0

6 files

1.2.6

6 files

This release

1.2.5 This release

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