Skip to content

Commit e939d5c

Browse files
committed
[DOC] add readme files
1 parent e77cc36 commit e939d5c

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

src/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
source
2+
=============
3+
4+
This contains the source code. It contains the following folders:
5+
6+
- [Examples](examples/)
7+

src/examples/README.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Examples
2+
=============
3+
4+
This folder contains example scripts using pyOpenMS:
5+
6+
* `convertToMGF.py`
7+
* A simple script to convert any spectra file readable by OpenMS (for
8+
example `mzXML` or `mzML`) to the `MGF` format. Python is only used to
9+
read in the spectra while writing of MGF is done natively in Python. MGF
10+
is used an example of any file format that is not currenly available
11+
through the OpenMS C++ library, showing how such a sample implementation
12+
could look like.
13+
- `peakpicker_scipyFFT.py`
14+
* A peakpicker using fast fourier transform (FFT) provided in `scipy` to
15+
smooth the provided spectrum and then applies the OpenMS
16+
`PeakPickerHiRes` on the result. The input spectrum and the picked peaks
17+
are then plotted using `matplotlib`, completing the integration of Python
18+
and OpenMS on multiple levels.
19+
- `pymol_example.py`
20+
* An example of mapping identified peptide sequences from an MS/MS
21+
experiment onto a 3D crystal strucutre of a protein using Python with
22+
`pymol`.
23+
- `runPhosphoScoring.py`
24+
* An implementation of a phospho-site scoring algorithm completely in
25+
Python using the available OpenMS data structures. It compares its result
26+
with the search-engine provided result and the one of the AScore
27+
algorithm as implemented in OpenMS.

0 commit comments

Comments
 (0)