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

Uploaded CPython 3.8+Windows x86-64

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

Uploaded CPython 3.8+macOS 11.0+ ARM64

opentimstdf-1.3.0-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.3.0.tar.gz.

File metadata

  • Download URL: opentimstdf-1.3.0.tar.gz
  • Upload date:
  • Size: 46.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.3.0.tar.gz
Algorithm Hash digest
SHA256 57784402e8388e34cc57d35d9abf4b8fb4655cd465e624f29251f02ce0b137d2
MD5 8d6f0a9f37982297a5f959a7808a4b15
BLAKE2b-256 d0fa272ab561e3199f829e5e72c740dd2df023fa0aaddb9f93893484ea3a0fe2

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: opentimstdf-1.3.0-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.3.0-cp38-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 89a09cee00419f4bec7d3c61d514df8c60442193867aac69cd0fb7e92700feb7
MD5 9f8fe54a07578fd5351f33808d9081e0
BLAKE2b-256 c62aaeaebbd662fb3a9c3205976c91ac895dfbdbb4e38fc05c9ac18371cac9e5

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.3.0-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b22b516997e8c4b569ccafa2233af0c56f577e66fa05543567e8214211e95752
MD5 7ba0bae8626994bb22935cb0cd3c81c6
BLAKE2b-256 3ca417d002307ac35a8a95fb8aac35b45f0d963d3cccd832e77c48dcd4d84624

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.3.0-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 3fc58117f5169d58addfc0772b5fa148ca721be802be685eeeeb6d11058c1103
MD5 6bd76c2a4dcae6c0c53d0020bbc2b42d
BLAKE2b-256 553ae370997dfc816f52d44d2f17a0491a584b0b256b9220c24876c98e43f38d

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.3.0-cp38-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 773b24bc8d00bda88c3f0eaf514085db1f99629129c1f65fbfd3f4b0d4c21337
MD5 a4010454f19848edc9cea492b98d5ee2
BLAKE2b-256 04f20518434d6ff634dc2051d1f6be3f94249081d2da7dcf0fa28ccdb795eeb8

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for opentimstdf-1.3.0-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 8b4345bd002a80f9c7c9bcba0ce477bde46ff5ffd825b88b0fac1002ebfafe0b
MD5 95be3860f33d6eee3d10edf90abe551f
BLAKE2b-256 90bb36768d9c1106f06ac1b2384c017d69d15e764ec0bccb933a320f5fc36c72

See more details on using hashes here.

Provenance

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

This release

1.3.0 This release

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