Merge pull request #219 from compomics/reimplement-predict-library

Reimplement predict library
compomics · May 8, 2024 · e595c9d · e595c9d
2 parents bd66087 + 5d1f11a
commit e595c9d
Show file tree

Hide file tree

Showing 17 changed files with 1,010 additions and 1,047 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -35,11 +35,11 @@ jobs:
 
       - name: Build and install ms2pip
         run: |
-          pip install .[test]
+          pip install .[dev]
 
-      # - name: Test with pytest
-      #   run: |
-      #     pytest
+      - name: Test with pytest
+        run: |
+          pytest
 
       - name: Test installation
         run: |

diff --git a/docs/source/api/ms2pip.search-space.rst b/docs/source/api/ms2pip.search-space.rst
@@ -0,0 +1,6 @@
+*******************
+ms2pip.search_space
+*******************
+
+.. automodule:: ms2pip.search_space
+   :members:
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -33,12 +33,22 @@ results in:
 ``predict-batch``
 -----------------
 
-[todo]
+Provide a list of peptidoforms (see :ref:`Peptides / PSMs`) to predict multiple spectra at once.
+For instance,
+
+.. code-block:: sh
+
+    ms2pip predict-batch peptides.tsv --model TMT
+
+results in a file ``test_predictions.csv`` with the predicted spectra.
+
 
 ``predict-library``
 -------------------
 
-[todo]
+Predict spectra for a full peptide search space generated from a protein FASTA file. Various
+peptide search space parameters can be configured to control the peptidoforms that are generated.
+See :ref:`ms2pip.search_space` for more information.
 
 This mode was first developed in collaboration with the ProGenTomics group for the
 `MS²PIP for DIA <https://github.com/brvpuyve/MS2PIP-for-DIA>`_ project.

diff --git a/fasta2speclib/__init__.py b/fasta2speclib/__init__.py