Skip to content

Commit 164d5b4

Browse files
Update README with library generation workflow
Added basic workflow instructions for library generation and loading.
1 parent d47bb75 commit 164d5b4

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,27 @@
33

44
# MS2Query 2.0
55
more to come...
6+
7+
## Basic workflow (so far):
8+
9+
### Library generation
10+
```python
11+
from ms2query.create_new_library import create_new_library
12+
13+
ms2query_lib = create_new_library(
14+
spectra_files=["spectra.mgf"],
15+
annotation_files=[],
16+
output_folder="my_ms2query_folder/",
17+
model_path="models/ms2deepscore.pt"
18+
)
19+
```
20+
21+
### Loading already generated library
22+
```python
23+
from ms2query.create_new_library import load_created_library
24+
25+
lib = load_created_library("my_ms2query_folder/")
26+
```
27+
28+
29+

0 commit comments

Comments
 (0)