Skip to main content

Ephyr

Documentation License: GPL v3

Ephyr is a lightweight yet powerful environment for labelling electrophysiological data. It combines an adaptive interface with intelligent performance scaling to match your machine’s resources, ensuring stable real-time operation even under heavy loads.

Fully open-source and built in Python, the platform provides a flexible API for post-annotation data access. Its add-on architecture lets you extend functionality seamlessly without modifying the core codebase.

Ephyr application overview

Documentation: https://ephyr.readthedocs.io/

Citation

Software

If you use this application in your research, please cite the software itself using the Zenodo DOI:

Kireev, A., & Suchkov, D. (2026). Ephyr: an open-source platform for visualizing and labeling multimodal electrophysiological data (Version 1.0.5). Zenodo. https://doi.org/10.5281/zenodo.21719977

Article (Coming Soon)

A peer-reviewed article describing this application is currently in preparation. We kindly ask that you consider citing it once it is published. The official reference and DOI will be updated here and in the CITATION.cff file upon publication.


License

Copyright (C) 2026 Life Improvement by Future Technologies (LIFT).

This project is licensed under the GNU General Public License v3.0 — see the LICENSE and COPYRIGHT files for details.

Development

Contributions are welcome via pull requests. To contribute:

  1. Fork the repository.
  2. Create a branch for your change.
  3. Make your changes and commit them using the commit message convention below.
  4. Open a pull request against the main branch.

Please keep pull requests focused and describe the motivation, changes, and testing performed.

Commit message convention

This project follows Conventional Commits. Use one of the following prefixes in your commit messages.

Core Conventional Commits types:

Type Meaning When to use Example
feat New feature Adds new functionality feat: add dark mode
fix Bug fix Fixes incorrect behavior fix: handle null user ID
docs Documentation README, comments, guides only docs: update install steps
style Code style/formatting Whitespace, formatting, semicolons — no logic change style: format with Prettier
refactor Refactoring Code change that neither fixes a bug nor adds a feature refactor: simplify validation logic
perf Performance Improves speed or memory usage perf: cache user lookup
test Tests Add or fix tests test: add parser edge cases
build Build system/dependencies Build tooling, bundler, package manager, external deps build: upgrade webpack to v5
ci Continuous integration CI config/scripts, GitHub Actions, GitLab CI, Travis ci: add test workflow
chore Maintenance Routine tasks not touching src or tests chore: update .gitignore
revert Revert Reverts a previous commit revert: feat: add dark mode

Example commit messages:

feat: add support for EDF+ files
fix(ui): prevent crash when no channel is selected
docs: update installation instructions

Breaking changes can be marked with ! after the type or scope, or with a BREAKING CHANGE: footer:

feat!: drop Python 3.9 support
fix(api)!: change response format

Changelog

To generate CHANGELOG.md use:

changelog-maestro --template devtools/changelog.md.j2

Metadata

Release files for ephyr 1.0.15

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ephyr 1.0.15
File Size Uploaded
ephyr-1.0.15.tar.gz 277.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ephyr 1.0.15
File Interpreter ABI Platform
ephyr-1.0.15-py3-none-any.whl Python 3 none any Details

Total release size: 591.0 kB

Release files / ephyr-1.0.15.tar.gz

Download URL ephyr-1.0.15.tar.gz
Size 277.8 kB
Tags Source
SHA-256 checksum
How to use checksums
06e7eb6e37b3fa860346a57859bbcb85d3365e1e89f5a3834fa670740cfba478
BLAKE2b-256 checksum
How to use checksums
7e5e43d821d0ddbda71696936d0d783c3e1e053888fcc44672341e3794c44981
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.11.10

Release files / ephyr-1.0.15-py3-none-any.whl

Download URL ephyr-1.0.15-py3-none-any.whl
Size 313.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
22729868708e423142d1cf633bd4b4ecbfce4a106fde2cd60a885641b0001c79
BLAKE2b-256 checksum
How to use checksums
e4e494923f9318d7a4506af49f0acaba287ab657395e8d8a9a65c6ee6a02d2b5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.11.10

Release history Release notifications | RSS feed

1.0.16

2 release files

This release

1.0.15 This release

2 release files

1.0.11

2 release files

1.0.10

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

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