Adding extracellular features; phase analysis features description in…

… docs #minor (#401) * adding extracellular features - Initial commit * add extracellualar feats docs * unit corrections docs * remove print * phase_feat_doc_update * minor doc fix * update changelog * fixing sphinx docs errors * moving back phase features in doc + typos + minor code changes * update changelog * remove irrelevant else statement * fix docstrings for sphinx * adding examples to docs * remove doc example rst files * minor text change in multiprocessing notebook * delete local rst files created by tox * imports to top and minor changes
BlueBrain · Jul 10, 2024 · 266ae13 · 266ae13
1 parent fa85d8c
commit 266ae13
Show file tree

Hide file tree

Showing 13 changed files with 1,945 additions and 31 deletions.
diff --git a/AUTHORS.txt b/AUTHORS.txt
@@ -6,3 +6,4 @@ Luis Riquelme @ BBP
 Tanguy Damart @ BBP
 Aurélien Jaquier @ BBP
 Anil Tuncel @ BBP
+Darshan Mandge @ BBP
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
 and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
 
+5.7.0 - 2024-07
+----------------
+
+- Adding extracellular features: `"peak_to_valley", "halfwidth", "peak_trough_ratio", "repolarization_slope", "recovery_slope","neg_peak_relative", "pos_peak_relative", "neg_peak_diff", "pos_peak_diff", "neg_image"` and `"pos_image"`
+- Add example for extracellular features
+- Documentation update to mention features that can be used fo phase analysis: `"AP_phaseslope", "phaseslope_max"`, `"AP_fall_rate", "AP_fall_rate_change", "AP_peak_downstroke", "AP_peak_upstroke", "AP_rise_rate"` and `"AP_rise_rate_change"``
+
 5.6.29 - 2024-06
 ----------------
 

diff --git a/docs/examples_to_rst.sh b/docs/examples_to_rst.sh
@@ -7,16 +7,22 @@ rm docs/source/nmc-portal.rst
 rm -rf docs/source/L5TTPC2_files
 rm docs/source/load_nwb.rst
 rm -rf docs/source/load_nwb_files
+rm docs/source/extrafeats_example.rst
+rm docs/source/multiprocessing_example.rst
 
 # convert
 jupyter nbconvert --to rst examples/sonata-network/sonata-network.ipynb
 jupyter nbconvert --to rst examples/nmc-portal/L5TTPC2.ipynb
 jupyter nbconvert --to rst examples/neo/load_nwb.ipynb
+jupyter nbconvert --to rst examples/extracellular/extrafeats_example.ipynb
+jupyter nbconvert --to rst examples/parallel/multiprocessing_example.ipynb
 
 # move
 mv examples/sonata-network/sonata-network.rst docs/source/
 mv examples/sonata-network/sonata-network_files docs/source/
 mv examples/nmc-portal/L5TTPC2.rst docs/source/nmc-portal.rst
 mv examples/nmc-portal/L5TTPC2_files docs/source/
 mv examples/neo/load_nwb.rst docs/source/
-mv examples/neo/load_nwb_files docs/source/
+mv examples/neo/load_nwb_files docs/source/
+mv examples/extracellular/extrafeats_example.rst docs/source/
+mv examples/parallel/multiprocessing_example.rst docs/source/
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -17,6 +17,7 @@ Submodules
    io
    pyfeatures.cppfeature_access
    pyfeatures.isi
+   pyfeatures.extrafeats
    pyfeatures.multitrace
    pyfeatures.pyfeatures
    pyfeatures.validation