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

Uploaded CPython 3.8+Windows x86-64

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

Uploaded CPython 3.8+macOS 11.0+ ARM64

opentimstdf-1.2.6-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.6.tar.gz.

File metadata

  • Download URL: opentimstdf-1.2.6.tar.gz
  • Upload date:
  • Size: 44.1 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.6.tar.gz
Algorithm Hash digest
SHA256 d60b42f06562964db3af1bbc958e4f67c3496c2f31b85c79c7a24caf5ee31447
MD5 b5988f44bfb7e30bbf0467719b97c0e1
BLAKE2b-256 d4f8e50a73c00e6cb0b57db44304c02443c9f69e10ea8575cd614f844cfc0cdb

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: opentimstdf-1.2.6-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.6-cp38-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 f7c7645ba518c03292ea6fda2a7180526f11650ffa6e3a857a4a63134652ba53
MD5 2ea2cf5d1eb42a17a98a8c5718df149a
BLAKE2b-256 1a157d2b625fa6d25cdf462ffdfd03b68f2bc7afa3102e27836e2fbc059ba8d0

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.2.6-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 df7374ca71fd3029c15bf519e564ef900b7fde35e8b1cb0bb039efd27eef4743
MD5 8a3357142a75d618672ebb2e30aaa36e
BLAKE2b-256 ca01931a40bf5fc56e8be3368b8b5f6a4222b4cb093071897a418a9140e6f6f2

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.2.6-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 a5dd79399fb7dbc5c0b77b73252cdbbfdf70b1b95ec63a384d1a25701d1b5722
MD5 5f7d9935c4b7233c36f6e6fc46b002cf
BLAKE2b-256 d1c87b9de1b20ab418e119f56de4255c201f8865fd76cd898d2702d6f761db06

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.2.6-cp38-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4a76ebc28b0f47875035072a2f2a40cb1aa168ff4305c52a8c83e747d788b2c9
MD5 84151b18dcf807d2e11cdc3c27d6369e
BLAKE2b-256 81f53a4207c2e6e330a26eec6f61e6696fe89e910e37a1e0314ded517482407a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.2.6-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 8e567fdfbd15cdd6b77162b72234b6c72c5de8099606c171da5fc78a3c8870ef
MD5 06686cab21ffa455404517cbfb4271af
BLAKE2b-256 6b24dab5c5a3786dee50b3bd7f7512729eaa364ac5359f728652ae0554310cab

See more details on using hashes here.

Provenance

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

This release

1.2.6 This release

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