Skip to content

Commit d1ece96

Browse files
committed
Point to tutorial notebook in readme
1 parent d55cff1 commit d1ece96

File tree

2 files changed

+26
-22
lines changed

2 files changed

+26
-22
lines changed

README.md

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,11 @@
22

33

44
# MS2Query 2.0
5-
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-
```
5+
A first basic implementation is out now, more to follow soon...
6+
The new MS2Query appraoch has a higher accuracy and has a much simpler and faster underlying algorithm. We will hopefully soon share a first preprint as well, showing all the benchmarking.
277

8+
The current runably version still requires to create the library files, which takes some time for the first run.
289

10+
Soon this will be much easier and faster. We will add downloadable precomputed files, make MS2Query pip installable, add a database and allow faster MS2DeepScore searching.
2911

12+
The tutorial for the current prototype can be found in notebooks/tutorial.

ms2query/readme.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Basic workflow (so far):
2+
This is for creating the database. This is not yet fully functional, so for now please use the notebooks/tutorial.ipynb if you already want to try out the prototype.
3+
4+
### Library generation
5+
```python
6+
from ms2query.create_new_library import create_new_library
7+
8+
ms2query_lib = create_new_library(
9+
spectra_files=["spectra.mgf"],
10+
annotation_files=[],
11+
output_folder="my_ms2query_folder/",
12+
model_path="models/ms2deepscore.pt"
13+
)
14+
```
15+
16+
### Loading already generated library
17+
```python
18+
from ms2query.create_new_library import load_created_library
19+
20+
lib = load_created_library("my_ms2query_folder/")
21+
```

0 commit comments

Comments
 (0)