Skip to main content

ethograph

Ethograph demo Labelling in Ethograph

Ethograph is a graphical user interface for visualizing and segmenting multimodal timeseries behavioural data. It builds upon a number of open-source libraries to load and quickly render video and pose files, audio and spectrograms, ephys recordings in various formats, and arbitrary multi-dimensional timeseries — all on one shared timeline.

Note this GUI is still in development. I welcome people testing it and providing feedback!

📖 Documentation

🎥 Watch the demo

Quickstart

First install uv, a fast Python package manager:

# macOS / Linux (except WSL)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
winget install astral-sh.uv

Then install the GUI as a standalone tool — one command, no environment to create or activate:

uv tool install --python 3.12 "ethograph[gui,audio]"

To open the GUI, run:

ethograph check # Linux only : Check for missing libraries
ethograph launch

ethograph not recognized? uv has not added its bin directory to your PATH yet. Run uv tool update-shell, then open a new terminal.

To upgrade later, run the same command with --force --refresh:

uv tool install --python 3.12 --force --refresh "ethograph[gui,audio]"

For installing into a dedicated virtual environment,segmentation models, and troubleshooting, see installation guide.

After launching, there are some example datasets you can explore the GUI with. To learn more about all the functionalities, I recommend the user manual.

Support

Open-source projects Ethograph depends on

Ethograph is built on top of a number of open-source projects: PyAV, audioio, Neo, crowsetta, Neurodata Without Borders, xarray, pynapple, movement, phy, PyQtGraph, and pygfx (via pynaviz). The models that segment behaviour build on DLC2Action, FERAL and E2E-Spot.

Ethograph is GPL-3.0-or-later. The code it vendors or adapts from other projects, and each one's licence, is listed in THIRD_PARTY_NOTICES.md.

Metadata

Release files for ethograph 0.2.55

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

Source distribution (sdist)

Source distribution for ethograph 0.2.55
File Size Uploaded Provenance
ethograph-0.2.55.tar.gz 40.7 MB Without provenance Details

Built distribution (wheel)

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

Total release size: 78.3 MB

Release files / ethograph-0.2.55.tar.gz

Download URL ethograph-0.2.55.tar.gz
Size 40.7 MB
Tags Source
SHA-256 checksum
How to use checksums
bebf7bacb0c34a9e4af349d36d17a30b5e08d7ce719bb384fcf609467ac0e0a6
BLAKE2b-256 checksum
How to use checksums
6d7cfcb7174025f52baaf5d4f5681cc98bc3756bfd1b314afe9e29e793d9d0ab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ethograph-0.2.55-py3-none-any.whl

Download URL ethograph-0.2.55-py3-none-any.whl
Size 37.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
dbd606408a08b9392e2f21f0d877b7b0280b3977e5d6fb3b9bf279ca03f1d2e6
BLAKE2b-256 checksum
How to use checksums
9dd5fef876b78ab677fbb31e7d70d5ba4284c77e84e24ea327c3f4f64703f8f1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Security for ethograph 0.2.55

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.2.55 This release

2 release files No provenance

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