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.53

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.53
File Size Uploaded
ethograph-0.2.53.tar.gz 40.6 MB Details

Built distribution (wheel)

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

Total release size: 78.3 MB

Release files / ethograph-0.2.53.tar.gz

Download URL ethograph-0.2.53.tar.gz
Size 40.6 MB
Tags Source
SHA-256 checksum
How to use checksums
f6b183a5ca56cb66db5cc6f17051c0615c8b9efd2ba219294b9b7491cb83beb7
BLAKE2b-256 checksum
How to use checksums
912d318bce9cd9a89a220f59c19a65a048e3de2ea9543a157978a9cf017e1ecc
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.53-py3-none-any.whl

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

Release history Release notifications | RSS feed

0.2.54

2 release files

This release

0.2.53 This release

2 release files

0.2.52

2 release files

0.2.51

2 release files

0.2.50

2 release files

0.2.49

2 release files

0.2.45

2 release files

0.2.44

2 release files

0.2.43

2 release files

0.2.42

2 release files

0.2.41

2 release files

0.2.40

2 release files

0.2.39

2 release files

0.2.38

2 release files

0.2.37

2 release files

0.2.36

2 release files

0.2.35

2 release files

0.2.34

2 release files

0.2.33

2 release files

0.2.24

2 release files

0.2.21

2 release files

0.2.19

2 release files

0.2.18

2 release files

0.2.17

2 release files

0.2.16

2 release files

0.2.15

2 release files

0.2.12

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.19

2 release files

0.1.18

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

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