Skip to content

Commit

Permalink
Update eFEL deprecated functions calls (#178)
Browse files Browse the repository at this point in the history
* update efel deprecated functions calls

* drop python 3.8 support

* update versioneer

---------

Co-authored-by: Kiliç Ilkan Fabrice <ikilic@bb-fvff870aq05n.epfl.ch>
  • Loading branch information
ilkilic and Kiliç Ilkan Fabrice committed May 7, 2024
1 parent 4bfe32a commit a8d5d56
Show file tree
Hide file tree
Showing 12 changed files with 1,090 additions and 567 deletions.
1 change: 1 addition & 0 deletions .gitattributes
@@ -0,0 +1 @@
bluepyefe/_version.py export-subst
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Expand Up @@ -10,7 +10,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11"]
python-version: ["3.9", "3.10", "3.11", "3.12"]

steps:
- uses: actions/checkout@v2
Expand Down
12 changes: 6 additions & 6 deletions README.rst
Expand Up @@ -70,7 +70,7 @@ BluePyEfe: Blue Brain Python E-feature extraction
Introduction
============

BluePyEfe aims at easing the process of reading experimental recordings and extracting
BluePyEfe aims at easing the process of reading experimental recordings and extracting
batches of electrical features from these recordings. To do so, it combines trace reading
functions and features extraction functions from the `eFel library <https://github.com/BlueBrain/eFEL>`_.

Expand All @@ -84,7 +84,7 @@ This software is citable using a `DOI generated by Zenodo <https://zenodo.org/re
Requirements
============

* `Python 3.8+ <https://www.python.org/downloads/release/python-380/>`_
* `Python 3.9+ <https://www.python.org/downloads/release/python-380/>`_
* `eFEL eFeature Extraction Library <https://github.com/BlueBrain/eFEL>`_ (automatically installed by pip)
* `Numpy <http://www.numpy.org>`_ (automatically installed by pip)
* `Scipy <https://www.scipy.org/>`_ (automatically installed by pip)
Expand Down Expand Up @@ -112,7 +112,7 @@ The e-features considered in the present package are the one implemented in the
The present package makes one major assumption: E-features are more meaningful if they are coming from a set of traces rather than a single trace. And they are even more meaningful if these traces come from different cells of the same cellular type.
This assumption dictates the organisation of the package and has several consequences:

The efeatures extracted through the package will always be averaged over the trace considered. For example, the AP_amplitude will be an average over all the action potentials present in a trace. If you wish to work on an AP by AP basis, please consider using the eFEL library directly.
The efeatures extracted through the package will always be averaged over the trace considered. For example, the AP_amplitude will be an average over all the action potentials present in a trace. If you wish to work on an AP by AP basis, please consider using the eFEL library directly.

A large part of the present software is therefore dedicated to averaging the features across set of "equivalent" recordings. To be able to average e-features across different cells in a meaningful way, an equivalence must be established between the traces coming from these different cells. It would not make sense to average the mean firing frequency obtain cell A on a 1s long step protocol with the one obtain for cell B on a ramp protocol that lasts for 500ms. We chose to define recordings as equivalent based on two criteria: (1) They have the same name and (2) they are of the same amplitude when the amplitude is expressed as a percentage of the rheobase of the cell.

Expand All @@ -130,7 +130,7 @@ Each of these steps are parametrized by a number of settings, therefore we recom
Coming from the legacy version
==============================
The legacy version (v0.4*) is moved to the legacy branch.
Changes introduced in v2.0.0 are listed in the `CHANGELOG.rst <CHANGELOG.rst>`_.
Changes introduced in v2.0.0 are listed in the `CHANGELOG.rst <CHANGELOG.rst>`_.
That is the only file you need to look at for the changes as the future changes will also be noted there.

Funding
Expand All @@ -139,10 +139,10 @@ This work has been partially funded by the European Union Seventh Framework Prog


..
The following image is also defined in the index.rst file, as the relative path is
The following image is also defined in the index.rst file, as the relative path is
different, depending from where it is sourced.
The following location is used for the github README
The index.rst location is used for the docs README; index.rst also defined an end-marker,
The index.rst location is used for the docs README; index.rst also defined an end-marker,
to skip content after the marker 'substitutions'.
.. substitutions
Expand Down
3 changes: 3 additions & 0 deletions bluepyefe/__init__.py
Expand Up @@ -23,3 +23,6 @@

__version__ = get_versions()["version"]
del get_versions

from . import _version
__version__ = _version.get_versions()['version']

0 comments on commit a8d5d56

Please sign in to comment.