Metadata-Version: 2.4
Name: msw-tasks-core
Version: 0.5.4
Summary: Murine Shift Work core tasks: liquid/sound calibration and hardware test protocols.
Author-email: "Lars B. Rollik" <lars@rollik.me>
License: Copyright (c) 2020-present Lars B. Rollik. All rights reserved.
        
        Permission is granted, free of charge, to use, copy, modify, and distribute
        this software and associated documentation files (the "Software") for
        non-commercial research or academic purposes only, subject to the following
        conditions:
        
        1. This copyright notice and permission notice must be included in all copies
           or substantial portions of the Software.
        
        2. Any publication, presentation, or product that uses or builds upon the
           Software must give clear attribution to the original work and its authors.
        
        3. Commercial use is prohibited without a separate written commercial licence
           agreement with the copyright holder. Commercial use means incorporation of
           the Software into anything for which fees or other compensation are charged
           or received, including commercial products and commercial services.
        
        4. No patent licence, express or implied, is granted under these terms. Any
           use that would require a patent licence from the copyright holder requires
           a separate written agreement.
        
        5. Redistribution, in source or binary form, is permitted only for
           non-commercial purposes and must retain this notice unmodified.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM,
        DAMAGES, OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE
        SOFTWARE OR THE USE OR DEALINGS IN THE SOFTWARE.
        
        For commercial or patent licensing enquiries contact: lars@rollik.me
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: msw-core>=0.11.5
Requires-Dist: numpy
Requires-Dist: one-axis-stage>=0.2.2
Requires-Dist: pybpod-api
Requires-Dist: pyyaml
Requires-Dist: tqdm
Provides-Extra: dev
Requires-Dist: commitizen; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material; extra == 'docs'
Requires-Dist: mkdocstrings[python]; extra == 'docs'
Description-Content-Type: text/markdown

# msw-tasks-core

Core task set for [Murine Shift Work](https://github.com/MurineShiftWork/murineshiftwork):
liquid and sound calibration protocols, plus minimal hardware test tasks.

Installs as a namespace contributor to `murineshiftwork.tasks.*`.
Tasks are discoverable by the `msw` CLI via both namespace path scan and `msw.tasks` entry points.

## Installation

```bash
pip install msw-tasks-core
```

Requires `murineshiftwork` to be installed.

## Tasks included

**Calibration**
- `_calibration_liquid_dynamic` - dynamic liquid volume calibration
- `_calibration_liquid_static` - static liquid volume calibration
- `_calibration_sound_latency` - sound output latency measurement

**Hardware tests**
- `_test_bpod_connect` - verify Bpod serial connection
- `_test_flush_valves` - flush all Bpod valve ports
- `_test_minimal_task` - minimal state-machine smoke test
- `_test_pulsepal_connect` - verify PulsePal connection
- `_test_stage_move` - exercise one-axis stage movement
- `_test_ttl_barcodes` - TTL barcode encoding/decoding test
- `_test_ttl_outputs` - BNC TTL output test
- `_test_barcode_iti` - barcode-in-ITI timing test
- `_test_video` - video acquisition smoke test

## Development

```bash
# from workspace root
uv sync
```
