From 8bfefdeac6ec73ee0771330c898c35b6a12b2e4a Mon Sep 17 00:00:00 2001 From: ilkilic Date: Thu, 7 Dec 2023 18:03:09 +0100 Subject: [PATCH] Update banner link for PyPI compatibility --- README.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index ab517ec..5be9ca7 100644 --- a/README.rst +++ b/README.rst @@ -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 `_. @@ -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. @@ -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 `_. +Changes introduced in v2.0.0 are listed in the `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 @@ -139,11 +139,11 @@ 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 -.. |banner| image:: docs/source/logo/BluePyEfeBanner.jpg +.. |banner| image:: https://raw.githubusercontent.com/BlueBrain/BluePyEfe/master/docs/source/logo/BluePyEfeBanner.jpg