Metadata-Version: 2.5
Name: benchside
Version: 0.4.1
Summary: Research colleagues with private project memory and optional workflow reporting.
Project-URL: Homepage, https://github.com/science-works/benchside
Project-URL: Documentation, https://github.com/science-works/benchside/blob/main/SETUP.md
Project-URL: Source, https://github.com/science-works/benchside
Project-URL: Issues, https://github.com/science-works/benchside/issues
Project-URL: Changelog, https://github.com/science-works/benchside/releases
Author-email: Rory Byrne <rory@rory.bio>
Maintainer: Science Works
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: agents,research,research-journal,science
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.11
Requires-Dist: dishka>=1.9.1
Requires-Dist: pydantic-settings>=2.12.0
Requires-Dist: pydantic>=2.12.4
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: rich>=15.0.0
Description-Content-Type: text/markdown

# Benchside

An AI workspace for doing science, maintained by **Science Works**. Benchside
provides eight research roles, private project records, saved decisions and
unresolved questions, and optional reviewed contributions to metascience research.

## Install for a local agent

Requires **Python 3.11+ on macOS or Linux**. Python 3.11 and 3.14 are tested.
Benchside supplies the skills and runtime; your agent supplies the model and
execution tools. It works with capable agents using OpenAI, Anthropic, other
providers or locally hosted models.

With uv:

```bash
uv tool install benchside
bench setup --agent codex
```

Or install with pip in a Python virtual environment:

```bash
python -m pip install benchside
bench setup --agent codex
```

Use `--agent claude` for Claude Code. For another agent, use
`bench setup --agent generic --skills-dir /path/to/that/agents/skills` after
identifying its actual skill directory. The agent can run these steps for you.
Then ask it to read the installed Benchside skill and complete guided setup:
choose private storage, select a project, and verify saving and restoring a
synthetic record. Installing the Python package alone does not complete that setup.

The package is named **benchside**; its command is **bench**. Upgrade with
`uv tool upgrade benchside` or `python -m pip install --upgrade benchside`, then
rerun the same `bench setup` command to refresh the installed skill. Keep private
records in their existing location. Every app sharing a notebook upgraded by
0.4.1 must use **0.4.1 or newer**, including apps previously running 0.4.0.

## Research roles and records

- Research supervisor and focused hypothesis reviewer
- Study-design consultant and methods troubleshooter
- Results discussant and reproducibility auditor
- Journal-club discussant and scientific peer reviewer

The agent selects a suitable role with the researcher. Decisions and research
records remain in the chosen private store, with ODT/Markdown reading copies
for local storage. Optional sharing is disabled initially; scientific findings
are excluded from metascience submissions. Workflow problems require review and
approval. Survey participation is agreed before answering.

## ChatGPT and Claude websites

This Python package does **not** install a web-app plugin or grant storage/network
permissions. For those apps, use the matching archive from
[GitHub Releases](https://github.com/science-works/benchside/releases/latest)
and follow the [setup guide](https://github.com/science-works/benchside/blob/main/SETUP.md).

[Source and full documentation](https://github.com/science-works/benchside) ·
[Report an issue](https://github.com/science-works/benchside/issues) ·
[Contribute a research role](https://github.com/science-works/benchside/blob/main/CONTRIBUTING.md)

Benchside is research software under active development, licensed under Apache 2.0.
