Skip to content

Commit

Permalink
DOCS: readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
sander-willems-bruker committed Oct 19, 2023
1 parent d9d009a commit d6923ec
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,28 @@ Add this crate to your `Cargo.toml`:
```toml
[dependencies]
timsrust = "x.x.x"
```

## Usage

TimsRust is intended to be used as a library and not as a stand-alone application. An example of how to use it is found in e.g. [Sage](https://github.com/lazear/sage).

### Basics

Two primary data types are exposed through TimsRust:
* Spectra: A traditional representation that expresses intensitites in function of mz values for a given precursor.
* Frames: All recorded data from a single TIMS elution (i.e. at one specific retention_time).

### File formats

Two file formats are supported:
* Bruker .d folder containing:
* analysis.tdf
* analysis.tdf_bin
* Bruker .ms2 folder containing:
* converter.ms2.bin
* converter.MS2Spectra.ms2.parquet

## Python bindings

The [timsrust_pyo3](https://github.com/jspaezp/timsrust_pyo3) package is an example of how the performance of TimsRust can be utilized in Python

0 comments on commit d6923ec

Please sign in to comment.