Skip to main content

Murine Shift Work — behavioural task acquisition with hardware support.

Project description

Murine Shift Work

Behavioural task acquisition with hardware support.

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/larsrollik/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.

Project details


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.15.1.tar.gz (170.8 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.15.1-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: murineshiftwork-2.15.1.tar.gz
  • Upload date:
  • Size: 170.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.22 {"installer":{"name":"uv","version":"0.11.22","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.15.1.tar.gz
Algorithm Hash digest
SHA256 bcdbd77eb892441a4fb8aed94f550e35c724f56f139c18e13df94cc68f659cee
MD5 b8cd69848bf15a4b31610f90d87be1ce
BLAKE2b-256 304a8290f4230b8b18a4d527f9653435e2ad2cfd06e0d8e69a1c8b17ecc39a82

See more details on using hashes here.

File details

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

File metadata

  • Download URL: murineshiftwork-2.15.1-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.22 {"installer":{"name":"uv","version":"0.11.22","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.15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 df3abf7845c5f923df3fea580c701ea7270d453c5c29d44ebbad6e7bc7939af8
MD5 8ebc0e08304774799014f836b18329a7
BLAKE2b-256 e43cf90aad6e269813e3abb081d00930834c9b2520d3fd833a536571d0c2bd2d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page