Circadian Workbench

Circadian Workbench is a local-first desktop application for circadian activity analysis. It imports supported ClockLab and tabular recordings, provides core rhythm views plus a 21-question non-cohort workbench, and preserves settings and provenance in project, result, figure, and recovery outputs.

Install

pip install "circadian-workbench[desktop]"
circadian-workbench-desktop

Python 3.10 or newer is required. The application runs only on the local machine; it has no account, login, hosted-service, or data-upload requirement.

Ask one question

No Python is needed:

circadian ask mouse01.awd period
circadian --list-questions

The same scientific engine is available through a small Python front door:

import circadian_workbench as cw

result = cw.open("mouse01.awd").period("lomb")
print(result.answer)

Numeric traces do not need to be turned into files or pandas DataFrames:

result = cw.trace(hours, values, name="cell 17").compare_periods()
result.show()

See the installed Callers and automation guide for populations, phases, measurement channels, result fields, errors, provenance and the version 1 local web application programming interface.

Main capabilities

• Actograms, profiles, onset/offset fits, fixed cosinor, non-parametric measures, spectral estimators, bouts, and quality checks.
• Period comparison, rhythmicity, instantaneous phase, entrainment and perturbation, immobility sleep, ultradian rhythm, temperature compensation, within-recording synchrony/spatial/coupling analyses, prospective power, and model prediction.
• Editable SVG and vector PDF publication bundles with exact plotted data and embedded ReproFig provenance.
• Verified application snapshots and disposable restore rehearsal.
• Public task-oriented documentation, also installed with the application, and machine-readable scientific action contracts.

Scientific status

This is beta research software. The distribution distinguishes implemented and internally tested methods from independent validation. Retain original recordings, inspect warnings, and verify outputs for the intended use.

Complete multi-recording experimental management is reserved for a future separately agreed workflow.

Released under the MIT License.