Murine Shift Work
Behaviour acquisition framework for standardised, scalable experiments.
msw run --setup rig-a --subject mouse001 --task sequence
What it does
- Behavioural tasks: sequence learning, probabilistic switching, optotagging, calibration routines
- Hardware abstraction: interchangeable backends for behaviour controllers, cameras, stage, scale, stimulators
- Config system: layered YAML overrides (bundled defaults, rig overlay, task mode, subject, CLI)
- Session files: structured
.msw.session.yaml+ JSONL trial data; reader API for analysis - Live plot: per-task online performance display during acquisition
- TTL barcodes: unique per-trial barcodes on BNC output for alignment with parallel recordings
Installation
Requires Python ≥ 3.12 and uv.
pip install murineshiftwork
First-time setup
msw init --config-dir /path/to/msw_configs
msw setup create rig-a
msw subject add -s mouse001
Development
git clone https://github.com/MurineShiftWork/murineshiftwork.git
cd murineshiftwork
uv sync --group dev
uv run pytest tests/
Pre-commit hooks (ruff, mypy, secrets scan):
pre-commit install
Docs
See docs/ for CLI reference, config system, session files, and task guides.
Key architecture decisions are in docs/MASTER_PLAN.md.
License
Copyright © 2021-2026 Lars B. Rollik. See LICENSE for terms.
1 maintainer
Metadata
1 maintainer
Release files for murineshiftwork 2.16.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| murineshiftwork-2.16.2.tar.gz | 167.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| murineshiftwork-2.16.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 172.0 kB
Release files / murineshiftwork-2.16.2.tar.gz
| Download URL | murineshiftwork-2.16.2.tar.gz |
|---|---|
| Size | 167.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
41ac2cd9f02e9f2feb0466e8603ee04ee490a84cf74096c0cd6e7edc2a9360d3
|
|
BLAKE2b-256 checksum How to use checksums |
625385228c07a10d14dd746461f88ad6acf9fbbc9249fa56422798c84c6e090c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.4 {"installer":{"name":"uv","version":"0.12.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / murineshiftwork-2.16.2-py3-none-any.whl
| Download URL | murineshiftwork-2.16.2-py3-none-any.whl |
|---|---|
| Size | 4.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
be91ac118b2691e3f2896984a107974ef6af8dae64eb54b3ddcc483b862024ec
|
|
BLAKE2b-256 checksum How to use checksums |
3be7fd334f0e8cbbe7ec51941f667a0129c359d91c28b8345cb4ab98ebba5e4e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.4 {"installer":{"name":"uv","version":"0.12.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
