Metadata-Version: 2.5
Name: msw-tasks-core
Version: 0.5.7
Summary: Murine Shift Work core tasks: liquid/sound calibration and hardware test protocols.
Author-email: "Lars B. Rollik" <lars@rollik.me>
License: BSD-3-Clause-NonCommercial
        
        Copyright (c) 2020-present, Lars B. Rollik.
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted for NON-COMMERCIAL research, academic, and
        educational purposes only, provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice,
           this list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its contributors
           may be used to endorse or promote products derived from this software
           without specific prior written permission.
        
        4. Any use of this software or its derivatives for COMMERCIAL purposes -
           including sale, paid licensing, or providing paid services built on it -
           requires a separate commercial licence. Contact lars@rollik.me.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
        ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
        LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
        SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
        INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
        CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
        ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
        POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Classifier: License :: Free for non-commercial use
Requires-Python: >=3.12
Requires-Dist: msw-core>=0.12.0
Requires-Dist: numpy
Requires-Dist: one-axis-stage>=0.2.2
Requires-Dist: pybpod-api
Requires-Dist: pyyaml
Requires-Dist: sshkeyboard
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
```
