Metadata-Version: 2.4
Name: opentimstdf
Version: 1.0.1
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: License :: OSI Approved :: Apache Software License
Summary: Rust reader for timsTOF .d/ (TDF) mass spectrometry bundles
Author-email: Nathan Riley <git@nathanriley.com>
License: Apache-2.0
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Changelog, https://github.com/Sigilweaver/OpenTimsTDF/blob/main/CHANGELOG.md
Project-URL: Documentation, https://sigilweaver.app/opentimstdf/docs
Project-URL: Homepage, https://github.com/Sigilweaver/OpenTimsTDF
Project-URL: Source, https://github.com/Sigilweaver/OpenTimsTDF

# opentimstdf (Python bindings)

Python bindings for the [OpenTimsTDF](https://github.com/Sigilweaver/OpenTimsTDF)
Rust crate.

```sh
pip install opentimstdf
```

```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](https://sigilweaver.app/opentimstdf/docs) for the full API.

## Build from source

Requires Rust 1.75+ and [maturin](https://www.maturin.rs):

```sh
cd python
maturin develop --release
```

## License

Apache-2.0.

