Merge pull request #4087 from SpikeInterface/prepare_release

Prepare release 0.103.0

Author: alejoe91

doc/api.rst

@@ -5,7 +5,7 @@ spikeinterface.core
 -------------------
 .. automodule:: spikeinterface.core
 
-    .. autofunction:: load_extractor
+    .. autofunction:: load
     .. autoclass:: BaseRecording
         :members:
     .. autoclass:: BaseSorting
@@ -27,7 +27,7 @@ spikeinterface.core
     .. autoclass:: BinaryRecordingExtractor
     .. autoclass:: ZarrRecordingExtractor
     .. autoclass:: BinaryFolderRecording
-    .. autoclass:: NpzFolderSorting
+    .. autoclass:: NumpyFolderSorting
     .. autoclass:: NpyFolderSnippets
     .. autoclass:: NumpyRecording
     .. autoclass:: NumpySorting
@@ -169,6 +169,9 @@ spikeinterface.preprocessing
 
 .. automodule:: spikeinterface.preprocessing
 
+    .. autofunction:: apply_preprocessing_pipeline
+    .. autofunction:: get_preprocessing_dict_from_analyzer
+    .. autofunction:: get_preprocessing_dict_from_file
     .. autofunction:: astype
     .. autofunction:: average_across_direction
     .. autofunction:: bandpass_filter
@@ -244,6 +247,7 @@ spikeinterface.sorters
 
     .. autofunction:: available_sorters
     .. autofunction:: installed_sorters
+    .. autofunction:: archived_sorters
     .. autofunction:: get_default_sorter_params
     .. autofunction:: get_sorter_params_description
     .. autofunction:: print_sorter_versions

doc/conf.py

@@ -49,8 +49,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'SpikeInterface'
-copyright = '2022, Alessio Paolo Buccino, Samuel Garcia, Cole Hurwitz, Jeremy Magland, Matthias Hennig'
-author = 'Alessio Paolo Buccino, Samuel Garcia, Cole Hurwitz, Jeremy Magland, Matthias Hennig'
+copyright = '2022-2025, SpikeInterface Team'
+author = 'SpikeInterface Team'
 
 
 # -- General configuration ---------------------------------------------------

doc/how_to/auto_curation_prediction.rst

@@ -1,5 +1,5 @@
-How to use a trained model to predict the curation labels
-=========================================================
+Use a trained model to predict the curation labels
+==================================================
 
 For a more detailed guide to using trained models, `read our tutorial here
 <https://spikeinterface.readthedocs.io/en/latest/tutorials/curation/plot_1_automated_curation.html>`_).

doc/how_to/auto_curation_training.rst

@@ -1,5 +1,5 @@
-How to train a model to predict curation labels
-===============================================
+Train a model to predict curation labels
+========================================
 
 A full tutorial for model-based curation can be found `here <https://spikeinterface.readthedocs.io/en/latest/tutorials/curation/plot_2_train_a_model.html>`_.
 

doc/how_to/build_pipeline_with_dicts.rst

@@ -1,5 +1,5 @@
-Build a full Sorting pipeline with dicts
-========================================
+Build a full spike sorting pipeline with dicts
+==============================================
 
 When using ``SpikeInterface`` there are two phases. First, you should
 play: try to figure out any special steps or parameters you need to play
@@ -122,7 +122,7 @@ and in the terminal ``help(si.bandpass_fitler)``)
             Margin in ms on border to avoid border effect
         dtype : dtype or None
             The dtype of the returned traces. If None, the dtype of the parent recording is used
-        **filter_kwargs : dict
+        \*\*filter_kwargs : dict
             Certain keyword arguments for `scipy.signal` filters:
                 filter_order : order
                     The order of the filter. Note as filtering is applied with scipy's

doc/how_to/combine_recordings.rst

@@ -1,5 +1,5 @@
-Combine recordings in SpikeInterface
-====================================
+Combine recordings (concatenate or append)
+==========================================
 
 In this tutorial we will walk through combining multiple recording objects. Sometimes this occurs due to hardware
 settings (e.g. Intan software has a default setting of new files every 1 minute) or the experimenter decides to

doc/how_to/handle_drift.rst

@@ -4,8 +4,8 @@
     %load_ext autoreload
     %autoreload 2
 
-Handle motion/drift with spikeinterface
-=======================================
+Handle motion/drift in your recording
+=====================================
 
 Spikeinterface offers a very flexible framework to handle drift as a
 preprocessing step. If you want to know more, please read the

doc/how_to/index.rst

@@ -7,17 +7,18 @@ Guides on how to solve specific, short problems in SpikeInterface. Learn how to.
     :maxdepth: 1
 
     viewers
-    handle_drift
-    analyze_neuropixels
-    load_matlab_data
+    customize_a_plot
     combine_recordings
     process_by_channel_group
+    build_pipeline_with_dicts
+    physical_units
+    unsigned_to_signed
+    ../tutorials/forhowto/plot_1_working_with_tetrodes
+    analyze_neuropixels
+    handle_drift
+    drift_with_lfp
+    load_matlab_data
     load_your_data_into_sorting
     benchmark_with_hybrid_recordings
-    drift_with_lfp
     auto_curation_training
     auto_curation_prediction
-    physical_units
-    unsigned_to_signed
-    customize_a_plot
-    ../tutorials/forhowto/plot_1_working_with_tetrodes

doc/how_to/load_your_data_into_sorting.rst

@@ -1,5 +1,5 @@
-Load your own data into a Sorting object
-========================================
+Load your own data into a ``Sorting`` object
+============================================
 
 Why make a :code:`Sorting`?
 

doc/how_to/physical_units.rst

@@ -1,7 +1,7 @@
 .. _physical_units:
 
-Working with physical units in SpikeInterface recordings
-========================================================
+Work with physical units in SpikeInterface recordings
+=====================================================
 
 In neurophysiology recordings, data is often stored in raw ADC (Analog-to-Digital Converter) integer values but needs to be analyzed in physical units.
 For extracellular recordings, this is typically microvolts (µV), but some recording devices may use different physical units.