Skip to content

Commit

Permalink
Minor doc updates: Update overview figure; refer to ms2rescore.rescor…
Browse files Browse the repository at this point in the history
…e in Python API tutorial; remove v3.0 warning in readme
  • Loading branch information
RalfG committed Aug 19, 2024
1 parent 4215f8d commit 2f588df
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@

Modular and user-friendly platform for AI-assisted rescoring of peptide identifications

> ⚠️ Note: This is the documentation for the fully redeveloped version 3.0 of MS²Rescore. While
> MS²Rescore 3.0 has been drastically improved over the previous version, you might run into some
> unforeseen issues. Please report any issues you encounter on the [issue tracker][issues] or post
> your questions on the [GitHub Discussions][discussions] forum.
## About MS²Rescore

MS²Rescore performs ultra-sensitive peptide identification rescoring with LC-MS predictors such as
Expand Down
Binary file modified docs/source/_static/img/ms2rescore-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/source/tutorials/in-depth-python-api.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,18 @@
"# Using the Python API "
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"This tutorial shows how to use the MS²Rescore Python API for each step of the rescoring process\n",
"individually. This is useful if you want to customize rescoring for your own Python\n",
"workflow or if you want to understand how MS²Rescore works.\n",
"\n",
"Note that the full MS²Rescore workflow is also available from Python with the single function call\n",
"`ms2rescore.rescore()`."
]
},
{
"cell_type": "code",
"execution_count": 1,
Expand Down

0 comments on commit 2f588df

Please sign in to comment.