Metadata-Version: 2.4
Name: openproteo
Version: 1.0.3
Summary: Open proteomics: one install for the OpenProteo vendor reader stack (Thermo, Bruker, Waters)
Author-email: Nathan Riley <git@nathanriley.com>
License: Apache-2.0
Project-URL: Homepage, https://github.com/Sigilweaver/OpenProteo
Project-URL: Documentation, https://github.com/Sigilweaver/OpenProteo
Project-URL: Source, https://github.com/Sigilweaver/OpenProteo
Project-URL: Issues, https://github.com/Sigilweaver/OpenProteo/issues
Keywords: mass-spectrometry,proteomics,raw,thermo,bruker,waters,tdf,mzml
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Rust
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: openproteo-io
Provides-Extra: thermo
Requires-Dist: opentfraw; extra == "thermo"
Provides-Extra: bruker
Requires-Dist: opentimstdf; extra == "bruker"
Provides-Extra: waters
Requires-Dist: openwraw; extra == "waters"
Provides-Extra: all
Requires-Dist: opentfraw; extra == "all"
Requires-Dist: opentimstdf; extra == "all"
Requires-Dist: openwraw; extra == "all"

# openproteo

`openproteo` is a thin Python metapackage that bundles the OpenProteo vendor reader stack:

| Vendor | Format         | Underlying package |
|--------|----------------|--------------------|
| Thermo | `.raw` file    | `opentfraw`        |
| Bruker | `.d/` bundle   | `opentimstdf`      |
| Waters | `.raw/` dir    | `openwraw`         |

## Install

Install just what you need:

```bash
pip install openproteo[thermo]
pip install openproteo[bruker]
pip install openproteo[waters]
```

Or install every supported vendor reader:

```bash
pip install openproteo[all]
```

## Usage

```python
import openproteo

kind = openproteo.detect("/data/sample.raw")     # "thermo" | "bruker" | "waters" | None
run  = openproteo.open_run("/data/sample.raw")    # vendor-specific reader object
```

`open_run` raises `ImportError` if the matching vendor extra is not installed and
`ValueError` if the format cannot be detected.

## License

Apache-2.0. See [`LICENSE`](../LICENSE).
