Metadata-Version: 2.4
Name: circadian-workbench
Version: 0.5.0
Summary: Local-first, reproducible circadian activity analysis
Author: Brancaccio Lab
Maintainer: Jay2owe
License-Expression: MIT
Project-URL: Homepage, https://pypi.org/project/circadian-workbench/
Keywords: circadian rhythms,actogram,activity analysis,chronobiology
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: analysis-kit>=0.1.0
Requires-Dist: fastapi>=0.115
Requires-Dist: uvicorn>=0.34
Requires-Dist: python-multipart>=0.0.20
Requires-Dist: numpy>=2.0
Requires-Dist: pandas>=2.2
Requires-Dist: scipy>=1.14
Requires-Dist: statsmodels>=0.14
Requires-Dist: PyWavelets>=1.6
Requires-Dist: plotly>=6.0
Requires-Dist: SQLAlchemy>=2.0
Requires-Dist: alembic>=1.13
Requires-Dist: argon2-cffi>=23.1
Provides-Extra: test
Requires-Dist: pytest>=8.0; extra == "test"
Requires-Dist: httpx>=0.27; extra == "test"
Provides-Extra: release
Requires-Dist: build>=1.0; extra == "release"
Dynamic: license-file

# Circadian Workbench

Circadian Workbench is a local-first application for transparent analysis of
activity rhythms. It imports ClockLab `.AWD` files and timestamped CSV files,
including metadata-prefixed MotionWatch exports, and provides actograms,
activity profiles, period analysis, cosinor fitting, bout analysis,
non-parametric measures, group statistics and reproducible exports.

The web interface and analysis service run on the same host. Uploaded data are
stored under a configurable local data root and are not sent to an external
service.

## Install and run

Circadian Workbench requires Python 3.10 or newer.

```powershell
pip install circadian-workbench
circadian-workbench
```

The interface opens at <http://127.0.0.1:8765>. Choose **Load demo** to explore
the workflow without an input file.

The default data root is home-relative at `~/.circadian-workbench`. Set the
application's documented environment variables before launch when a different
durable location is required.

## Command-line entry points

- `circadian-workbench` starts the local application.
- `circadian-workbench-service` runs the service without opening a browser.
- `circadian-workbench-admin` exposes administrative maintenance commands.

## Reproducibility

Imports retain source checksums and original bytes. Analysis actions record
their parameters and software version, and figure exports retain the values
used to draw them. Invalid or incomplete time series are reported rather than
silently regularised.

## Support status

Circadian Workbench is pre-1.0 research software. Validate exported results for
the intended scientific use and retain the original activity records.

## License

Released under the MIT License; the license text is included in every source
and wheel distribution.
