Metadata-Version: 2.4
Name: analysis-kit
Version: 0.1.0
Summary: Shared house style and agent chassis for the lab's analysis projects
Author: Brancaccio Lab
Maintainer: Jay2owe
License-Expression: MIT
Project-URL: Homepage, https://pypi.org/project/analysis-kit/
Keywords: scientific analysis,provenance,figure style,automation
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
Provides-Extra: test
Requires-Dist: pytest>=8.0; extra == "test"
Dynamic: license-file

# analysis-kit

One installable package carrying the house figure style and the agent chassis
for every analysis project in the lab, so the look, the audit trail and the way
an agent asks "what can I run here?" are written once instead of four times.

Consumers: PyFLASH (immunofluorescence), CircadianWorkbench (activity
recordings), and the microglia protocols.

## What is here now

| Module | What it does |
| --- | --- |
| `registry` | `ParamDoc`, `ActionSpec`, `Registry` — a project declares what an agent may run, with units and meanings written down rather than guessed from signatures |
| `knowledge` | `describe`, `validate`, `discover`, `doctor` — the four questions an agent asks before it runs anything |
| `reference_gen` | Rebuilds the generated half of a reference doc from the registry, leaving hand-written prose untouched |
| `style` | Shared palettes, themes and figure-conformance checks |
| `capture` | Run records, equivalent scripts and output discovery |
| `audit` | Indexed run history, result summaries and linked notes |
| `cli` and `worker` | A reusable command-line and queued-job chassis supplied with a project registry |

## Two rules the package is built around

**The kit never imports a project.** Everything it needs arrives on the
`Registry` a project hands it. If a module here ever names a project, the
abstraction has failed.

**No scientific dependency at import time.** Every project depends on this one,
so `import analysis_kit` must stay as cheap as importing `json`. `tests/`
enforces it.

## Install

```
pip install analysis-kit
```

The import package uses an underscore:

```python
import analysis_kit

print(analysis_kit.__version__)
```

For development:

```powershell
git clone https://github.com/Jay2owe/analysis-kit.git
cd analysis-kit
pip install -e ".[test]"
python -m pytest
```

## Support status

`analysis-kit` is the shared infrastructure for Brancaccio Lab analysis
projects. Its public API is pre-1.0 and may change between minor releases.

## License

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