Skip to main content

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.

Download files

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

Source Distribution

murineshiftwork-2.16.2.tar.gz (167.2 kB view details)

Uploaded Source

Built Distribution

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

murineshiftwork-2.16.2-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file murineshiftwork-2.16.2.tar.gz.

File metadata

  • Download URL: murineshiftwork-2.16.2.tar.gz
  • Upload date:
  • Size: 167.2 kB
  • Tags: Source
  • Uploaded using 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}

File hashes

Hashes for murineshiftwork-2.16.2.tar.gz
Algorithm Hash digest
SHA256 41ac2cd9f02e9f2feb0466e8603ee04ee490a84cf74096c0cd6e7edc2a9360d3
MD5 367da0f469732b73c26b24f6a82ce019
BLAKE2b-256 625385228c07a10d14dd746461f88ad6acf9fbbc9249fa56422798c84c6e090c

See more details on using hashes here.

File details

Details for the file murineshiftwork-2.16.2-py3-none-any.whl.

File metadata

  • Download URL: murineshiftwork-2.16.2-py3-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 3
  • Uploaded using 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}

File hashes

Hashes for murineshiftwork-2.16.2-py3-none-any.whl
Algorithm Hash digest
SHA256 be91ac118b2691e3f2896984a107974ef6af8dae64eb54b3ddcc483b862024ec
MD5 e61eda0103ec8faa1acffa97a38e8fa5
BLAKE2b-256 3be7fd334f0e8cbbe7ec51941f667a0129c359d91c28b8345cb4ab98ebba5e4e

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

2.16.2 This release

2 files

2.16.1

2 files

2.16.0

2 files

2.15.8

2 files

2.15.7

2 files

2.15.6

2 files

2.15.5

2 files

2.15.4

2 files

2.15.3

2 files

2.15.2

2 files

2.15.1

2 files

2.15.0

2 files

0.1.1

2 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