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

Uploaded CPython 3.8+Windows x86-64

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

Uploaded CPython 3.8+macOS 11.0+ ARM64

opentimstdf-1.3.2-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.2.tar.gz.

File metadata

  • Download URL: opentimstdf-1.3.2.tar.gz
  • Upload date:
  • Size: 53.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.2.tar.gz
Algorithm Hash digest
SHA256 55418441b66145e1d8b6080ac201389af51d5213fd680405a4c6966a8f9ea440
MD5 2252b87230d69c0156bacb64388df3eb
BLAKE2b-256 d41b1702b1bd32e7d43b309bf4d8cf5f8d5c327d8bf311056e57b1929f1166ef

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: opentimstdf-1.3.2-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.2-cp38-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 8eb8223f955a7d42868517357389300e9a4a59c50d39bb3b55d74cbaac7905f1
MD5 1c07f9d0cc9696ac3c4bda6695535ad0
BLAKE2b-256 5918e9a9d743d1a60452c88d548fd0e4ff502ebac20c585757f943562de7a321

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.3.2-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 5e2957cb86b3ea098c35a7621cbb57a85c760e08c75cd0b70a284da8aa37b877
MD5 9c1fcaa2f4d8620753f5a5f19cd25864
BLAKE2b-256 77c86eac2cea6a16dcfebc1d1df42fd4e07b4ff3d0ec08498cefa0f2eb798838

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.3.2-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 939ffdd8cfa3a232e5c3ab84968edd2b38cfadbffb5dc342b60311c5af6bbfe8
MD5 a39b3ce889d93067569a7915bc38012a
BLAKE2b-256 3fe70b02c152a4c78ea724bb5b894e9c12c0822b3e659385118a376984eb92e8

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.3.2-cp38-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 8245f3560d28c8917ea5ca12076538562eb39d5f530f10396ee02810e4e94ecc
MD5 268cf34a9a5a38820263c856d6bb0625
BLAKE2b-256 8c190481a23122bc5a58023e90c7c23e33a512058438625ae7c8765661ec9811

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.3.2-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 69fd54ff91aba5bb5f1a020d06fdd936d5d2a5b86d5cb754cdfba1464831cee4
MD5 5a2bd1013b70190d986515dc9fc3c9ea
BLAKE2b-256 313badcd5ded5d255eac3df585640d20fe158cb860b32be542d14c1ff158b272

See more details on using hashes here.

Provenance

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

This release

1.3.2 This release

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