Metadata-Version: 2.4
Name: researchx
Version: 0.0.1
Summary: Automated research experiment orchestrator — plan, run, evaluate, iterate.
Project-URL: Homepage, https://github.com/jellyheadandrew/researchx
Project-URL: Repository, https://github.com/jellyheadandrew/researchx
Project-URL: Issues, https://github.com/jellyheadandrew/researchx/issues
Author: jellyheadandrew
License-Expression: MIT
License-File: LICENSE
Keywords: ai,automation,experiments,orchestrator,research
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Requires-Dist: click>=8.1
Requires-Dist: jinja2>=3.1
Requires-Dist: prompt-toolkit>=3.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.0
Provides-Extra: dev
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: types-pyyaml; extra == 'dev'
Description-Content-Type: text/markdown

<p align="center">
  <img src="researchx.png" alt="ResearchX" width="400">
</p>

# ResearchX

Experiment 24/7 while you sleep. Research assistant for projects.

> ⚠️ **Alpha Release** — ResearchX is in active development. Core loop works, but expect rough edges. Bug reports and feedback welcome: [GitHub Issues](https://github.com/jellyheadandrew/researchx/issues)

## Alpha Status

This project is currently alpha and intended for fast iteration.

Known limitations:
- New-experiment loop behavior is still being hardened.
- Abort handling is not yet uniform across every state.
- Autopilot transition audit logging is still being refined.

## Install

```bash
pipx install researchx
pipx ensurepath          # one-time: adds ~/.local/bin to PATH
```

Then restart your shell. This works everywhere — bare terminal, conda environments, virtualenvs.

**Alternative** (if pipx is unavailable):

```bash
pip install researchx
```

> Note: `pip install` places researchx inside your current environment. This may cause dependency conflicts with project packages. Prefer `pipx` + `ensurepath` for an isolated install.

**Fallback** (if `researchx` command is not on PATH):

```bash
python -m researchx .
```

## Troubleshooting

- **`researchx: command not found`** after install — Run `pipx ensurepath` and restart your shell. This adds `~/.local/bin` to your PATH so the command is available in all environments, including conda.

## Usage

```bash
researchx .
researchx /path/to/project
researchx status
```

## What it does NOT do

- Not a paper writing tool — it runs experiments, not LaTeX

---

Built by [Sookwan Han](https://jellyheadandrew.github.io) · ICCV 2023 Oral · ECCV 2024 Oral · CVPR 2025
