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

Uploaded CPython 3.8+Windows x86-64

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

Uploaded CPython 3.8+macOS 11.0+ ARM64

opentimstdf-1.2.4-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.4.tar.gz.

File metadata

  • Download URL: opentimstdf-1.2.4.tar.gz
  • Upload date:
  • Size: 40.4 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.4.tar.gz
Algorithm Hash digest
SHA256 92f332d3058ee117e4877eb8db4f608e08c54e542c60fdc76de817c7634d40d0
MD5 a4c17a3927aa44c1704fcf168495558b
BLAKE2b-256 2eb7018d9cfc9cad71d930cd18ac689a8aebdf16ea82ae1c9da80abbf73e2e20

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: opentimstdf-1.2.4-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.4-cp38-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 2f1941f99d868cad3d0cdff76ba61ffa69889f9e363eb2c882804667aa9bb5e0
MD5 85554c97645639b4451dcc6cfbd697f8
BLAKE2b-256 31196182e7d9c3c64333eddc62ad9d16ff443e85e6394a7265d764674f19ad5f

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.2.4-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 f744aefdb8aa5cd22f5e552f2479e681a86ba258f5a5c58be92bdf05c77df575
MD5 d555d56bd5c22d269b321d898f85b1dd
BLAKE2b-256 6966e4d79d89346b8748242b1c3f373eab2144b654b4bb85555187740d4407a3

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.2.4-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 df5f816d57d89fb42bcff80eaee1d9c9aced7e40aaa0ed1982414f7e8d6afcf2
MD5 303137cb4bc26678f3a1fc82c950b9ef
BLAKE2b-256 bfdd123ba88a0fd0e212c4333375784fef43bd8b54f8267d32c0dc022e923738

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.2.4-cp38-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d58c13c273d0ed77bc34d6d14c963f33bc19f19f31c3545bec501ce40c8512b1
MD5 ce5246403cb5fc62bf20e5a99b384528
BLAKE2b-256 362c1fc59938646172952596324e4770424a99db2cb864da531e7f7003b18783

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.2.4-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 1e79282f6b084691e6e7262992d2b23d2b15602621dfe2264220056d36c5aa1e
MD5 e374265765be50980138bb80ab8d5481
BLAKE2b-256 ac65e608f970585d133f289005ecafab4f3fcbde80a59fd9aefb9e5882219ace

See more details on using hashes here.

Provenance

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

1.2.5

6 files

This release

1.2.4 This release

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