Update get_started and we_to_sa

SpikeInterface · Apr 17, 2024 · b273622 · b273622
1 parent a1cacde
commit b273622
Show file tree

Hide file tree

Showing 12 changed files with 133 additions and 426 deletions.
diff --git a/doc/how_to/get_started.rst b/doc/how_to/get_started.rst
diff --git a/doc/how_to/get_started_files/get_started_52_0.png b/doc/how_to/get_started_files/get_started_52_0.png
diff --git a/doc/how_to/get_started_files/get_started_55_0.png b/doc/how_to/get_started_files/get_started_55_0.png
diff --git a/...to/get_started_files/get_started_84_1.png → ...to/get_started_files/get_started_87_1.png b/...to/get_started_files/get_started_84_1.png → ...to/get_started_files/get_started_87_1.png
diff --git a/...to/get_started_files/get_started_84_2.png → ...to/get_started_files/get_started_87_2.png b/...to/get_started_files/get_started_84_2.png → ...to/get_started_files/get_started_87_2.png
diff --git a/doc/how_to/get_started_files/get_started_90_1.png b/doc/how_to/get_started_files/get_started_90_1.png
diff --git a/doc/how_to/get_started_files/get_started_90_2.png b/doc/how_to/get_started_files/get_started_90_2.png
diff --git a/doc/how_to/get_started_files/get_started_93_1.png b/doc/how_to/get_started_files/get_started_93_1.png
diff --git a/doc/how_to/get_started_files/get_started_93_2.png b/doc/how_to/get_started_files/get_started_93_2.png
diff --git a/doc/how_to/waveform_extractor_to_sorting_analyzer.rst b/doc/how_to/waveform_extractor_to_sorting_analyzer.rst
@@ -312,9 +312,9 @@ Compute Extensions
 
 Waveforms, templates, quality metrics etc are all extensions of the ``SortingAnalyzer`` object.
 Some extensions depend on other extensions. To calculate a *child* we must first have calculated its
-**parents**. The relationship between some commonly used extensions are shown below:
+**parents**. The relationship between all the currently available extensions is displayed below:
 
-.. image:: waveform_extractor_to_sorting_analyzer_files/child_parent_plot.svg
+.. image:: ../images/parent_child.svg
     :alt: Child parent relationships
 
 We see that to compute ``spike_amplitudes`` we must first compute ``templates``. To compute templates
@@ -348,7 +348,8 @@ looks slightly different. Let's calculate these extensions, and also add a param
                 peak_sign="pos"
             )
 
-Read more about extensions and their keyword arguments in the
+Note that if a parent is recomputed, all its children are deleted to maintain data consistency.
+Read more about this, the extensions and their keyword arguments in the
 `postprocessing module documentation <https://spikeinterface.readthedocs.io/en/latest/modules/postprocessing.html>`_
 
 In many cases, you can still use the old notation for ``SortingAnalyzer`` objects,

diff --git a/doc/how_to/waveform_extractor_to_sorting_analyzer_files/child_parent_plot.svg b/doc/how_to/waveform_extractor_to_sorting_analyzer_files/child_parent_plot.svg
diff --git a/examples/how_to/get_started.py b/examples/how_to/get_started.py
@@ -254,7 +254,7 @@
 analyzer_TDC.compute("template_similarity", method="cosine_similarity")
 # -
 
-# Find out more about the available parameters and extensions [here](https://spikeinterface.readthedocs.io/en/latest/modules/postprocessing.html#available-postprocessing-extensions).
+# Find out more about the available parameters and extensions [here](https://spikeinterface.readthedocs.io/en/latest/modules/postprocessing.html).
 
 # The calculations are saved in the `extensions` subfolder of the `SortingAnalyzer` folder.
 # Similar to the waveforms we can access them using `get_extension` and `get_data`. For example,