banner

BluePyEfe: Blue Brain Python E-feature extraction

Latest Release

latest release

Documentation

latest documentation

License

license

Build Status

Actions build status

Coverage

coverage

Citation

DOI

Gitter

gitter

Introduction

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.

BluePyEfe outputs protocols and features files in the format used by BluePyOpt for neuron electrical model building.

How to cite

If you use this repository in your work, please refer to the “Cite this repository” button at the top of the repository page to get various citation formats, including APA and BibTeX.

For detailed citation information, please refer to the CITATION.cff file.

Requirements

  • Python 3.11+

  • eFEL eFeature Extraction Library (automatically installed by pip)

  • Numpy (automatically installed by pip)

  • Scipy (automatically installed by pip)

  • Neo (automatically installed by pip)

  • The instruction below are written assuming you have access to a command shell on Linux / UNIX / MacOSX / Cygwin

Installation

To install BluePyEfe, run:

pip install bluepyefe

Quick Start and Operating Principle

For a hands-on introduction to BluePyEfe, have a look at the notebook examples/example_of_extraction.ipynb. For an NWB-focused example, see examples/nwb_extraction.ipynb.

The goal of the present package is to extract meaningful electrophysiological features (e-features) from voltage time series. The e-features considered in the present package are the one implemented in the eFEL python library. See this pdf for a list of available e-features.

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.

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.

A pseudo-code for the main function of the package (bluepyefe.extract.extract_efeatures) could look as follows:

  1. Load the data to memory by reading all the files containing the traces

  2. Extract the required e-features for all the traces

  3. Compute the rheobases of the cells based on one or several protocols

  4. Use these rheobases to associate to each protocol an amplitude expressed in % of the rheobase

  5. Compute the mean and standard deviations for the e-features across traces having the same amplitude

  6. Save the results and plot the traces and e-features

Each of these steps are parametrized by a number of settings, therefore we recommend that you read carefully the docstring of the function.

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. That is the only file you need to look at for the changes as the future changes will also be noted there.

Funding

This work has been partially funded by the European Union Seventh Framework Program (FP7/2007­2013) under grant agreement no. 604102 (HBP), and by the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreements No. 720270 (Human Brain Project SGA1) and No. 785907 (Human Brain Project SGA2) and by the EBRAINS research infrastructure, funded from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3).

Copyright (c) 2016-2024 Blue Brain Project/EPFL

Copyright (c) 2025-2026 Open Brain Institute

Project links

Data verified by PyPI on Aug 21, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.3.63)

4 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for aurelienjaquier from gravatar.com aurelienjaquier Avatar for bbp.opensource from gravatar.com bbp.opensource Avatar for obi.maintainer from gravatar.com obi.maintainer
+1 more Avatar for wvangeit from gravatar.com wvangeit

Credits

Author: Open Brain Institute

GitHub Statistics

Data verified by PyPI on Aug 21, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

GNU Lesser General Public License v3 (LGPLv3) (BluePyEfe - Bluebrain Python E-feature extraction Library)

Requires

Python >=3.11

Tags

neuroscience BlueBrainProject

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bluepyefe-2.3.62.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bluepyefe-2.3.62-py3-none-any.whl (74.4 kB view details)

Uploaded Python 3

File details

Details for the file bluepyefe-2.3.62.tar.gz.

File metadata

  • Download URL: bluepyefe-2.3.62.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for bluepyefe-2.3.62.tar.gz
Algorithm Hash digest
SHA256 7f07817242cd2155fb19c5c2bc142d3bf06ae77968aa4634065b9d525a9446f0
MD5 8755de248f1b2e11d6ec39c2bbc19c6a
BLAKE2b-256 bb737a5229e5572fbb9a3a5cab128b90f691356ae3c6cb761baf83df19db14a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for bluepyefe-2.3.62.tar.gz:

Publisher: build.yml on openbraininstitute/BluePyEfe

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bluepyefe-2.3.62-py3-none-any.whl.

File metadata

  • Download URL: bluepyefe-2.3.62-py3-none-any.whl
  • Upload date:
  • Size: 74.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for bluepyefe-2.3.62-py3-none-any.whl
Algorithm Hash digest
SHA256 4c6d239cc03cde8c7d361fde3da131506c0e775676b12e3aff0f347a454f180b
MD5 5957fd07126d84aa2d78be7ef0ce5e8b
BLAKE2b-256 d258fee592d7fa5b2d7763774e61d87779e75067ed2479938d0fecbd46413193

See more details on using hashes here.

Provenance

The following attestation bundles were made for bluepyefe-2.3.62-py3-none-any.whl:

Publisher: build.yml on openbraininstitute/BluePyEfe

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

2.3.63

2 files

This release

2.3.62 This release

2 files

2.3.61

2 files

2.3.60

2 files

2.3.59

2 files

2.3.58

2 files

2.3.57

2 files

2.3.56

2 files

2.3.55

2 files

2.3.54

2 files

2.3.53

2 files

2.3.52

2 files

2.3.51

2 files

2.3.50

2 files

2.3.49

2 files

2.3.48

2 files

2.3.47

2 files

2.3.46

2 files

2.3.45

2 files

2.3.44

2 files

2.3.43

2 files

2.3.42

2 files

2.3.41

2 files

2.3.39

2 files

2.3.38

2 files

2.3.35

2 files

2.3.34

2 files

2.3.33

2 files

2.3.32

2 files

2.3.31

2 files

2.3.30

2 files

2.3.29

2 files

2.3.28

2 files

2.3.27

2 files

2.3.26

2 files

2.3.25

2 files

2.3.24

2 files

2.3.23

2 files

2.3.22

2 files

2.3.21

2 files

2.3.20

2 files

2.3.19

2 files

2.3.18

2 files

2.3.17

2 files

2.3.16

2 files

2.3.15

2 files

2.3.14

2 files

2.3.13

2 files

2.3.12

2 files

2.3.11

2 files

2.3.10

2 files

2.3.9

2 files

2.3.8

2 files

2.3.7

2 files

2.3.6

2 files

2.3.5

2 files

2.3.4

2 files

2.3.3

2 files

2.3.2

2 files

2.3.1

2 files

2.3.0

2 files

2.2.72

2 files

2.2.70

2 files

2.2.67

2 files

2.2.65

2 files

2.2.63

2 files

2.2.61

2 files

2.2.59

2 files

2.2.55

2 files

2.2.53

2 files

2.2.51

2 files

2.2.50

2 files

2.2.49

2 files

2.2.48

2 files

2.2.47

2 files

2.2.46

2 files

2.2.45

2 files

2.2.43

2 files

2.2.41

2 files

2.2.40

2 files

2.2.37

2 files

2.2.36

2 files

2.2.34

2 files

2.2.33

2 files

2.2.30

2 files

2.2.25

2 files

2.2.24

2 files

2.2.23

2 files

2.2.22

2 files

2.2.21

2 files

2.2.20

2 files

2.2.18

2 files

2.2.17

2 files

2.2.16

2 files

2.2.15

2 files

2.2.14

2 files

2.2.12

2 files

2.2.11

2 files

2.2.2

2 files

2.2.1

2 files

2.2

2 files

2.1.28

2 files

2.1.27

2 files

2.1.26

2 files

2.1.25

1 file

2.1.24

1 file

2.1.22

1 file

0.4.10

2 files

0.4.7

2 files

0.4.5

2 files

0.4.2

2 files

0.3.157

2 files

0.3.150

2 files

0.3.133

2 files

0.3.131

2 files

0.3.123

2 files

0.3.118

1 file

0.3.104

1 file

0.3.102

1 file

0.3.98

1 file

0.3.94

1 file

0.3.90

1 file

0.3.88

1 file

0.3.84

1 file

0.3.81

1 file

0.3.79

1 file

0.3.75

1 file

0.3.73

1 file

0.3.67

1 file

0.3.56

1 file

0.3.53

1 file

0.3.51

1 file

0.3.43

1 file

0.3.41

1 file

0.3.38

1 file

0.3.36

1 file

0.3.34

1 file

0.3.23

1 file

0.3.13

1 file

0.3.11

1 file

0.3.9

1 file

0.3.7

1 file

0.3

1 file

0.2.34

1 file

0.2.8

1 file

0.2.6

1 file

0.2.4

1 file

0.2.2

1 file

0.1.15

1 file

0.1.13

1 file

0.1.12

1 file

0.1.3

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page