Metadata-Version: 2.4
Name: ai-research-os
Version: 1.5.4
Summary: A Self-Evolving Research OS for AI Researchers — manage papers, detect research gaps, generate insights
Author-email: shushuzn <shushuzn@example.com>
License: GPL-3.0-or-later
Project-URL: Homepage, https://github.com/shushuzn/ai_research_os
Project-URL: Repository, https://github.com/shushuzn/ai_research_os
Project-URL: Documentation, https://github.com/shushuzn/ai_research_os#readme
Keywords: research,ai,papers,arxiv,notes,zettelkasten
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.33.1
Requires-Dist: feedparser>=6.0.12
Requires-Dist: pymupdf>=1.27.2.3
Requires-Dist: pillow>=12.2.0
Requires-Dist: psutil>=7.2.2
Requires-Dist: aiohttp>=3.13.5
Requires-Dist: numpy>=2.2.6
Requires-Dist: orjson>=3.11.8
Requires-Dist: httpx>=0.28.1
Requires-Dist: textual>=8.2.4
Requires-Dist: rich>=15.0.0
Requires-Dist: jieba>=0.42.1
Requires-Dist: pymilvus>=2.6.12
Provides-Extra: ocr
Requires-Dist: pytesseract>=0.3.13; extra == "ocr"
Requires-Dist: pillow>=12.2.0; extra == "ocr"
Provides-Extra: web
Requires-Dist: streamlit>=1.57.0; extra == "web"
Provides-Extra: ai
Requires-Dist: openai>=2.33.0; extra == "ai"
Provides-Extra: dev
Requires-Dist: pytest>=9.0.3; extra == "dev"
Requires-Dist: pytest-cov>=7.1.0; extra == "dev"
Requires-Dist: pytest-xdist>=3.8.0; extra == "dev"
Requires-Dist: freezegun>=1.5.5; extra == "dev"
Provides-Extra: slides
Requires-Dist: python-pptx>=1.0.2; extra == "slides"
Provides-Extra: all
Requires-Dist: ai-research-os[ai,dev,ocr,slides]; extra == "all"
Dynamic: license-file

# AI Research OS

<div align="center">
  <img src="logo_hero.png" width="800" alt="AI Research OS Demo"/>
</div>

**A Self-Evolving Research Operating System for AI Researchers**

[![Python](https://img.shields.io/badge/Python-3.9%2B-blue)](https://python.org)
[![PyPI Version](https://img.shields.io/pypi/v/ai-research-os)](https://pypi.org/project/ai-research-os/)
[![Coverage](https://img.shields.io/codecov/c/github/shushuzn/ai_research_os/main?logo=codecov)](https://app.codecov.io/gh/shushuzn/ai_research_os)
[![Tests](https://github.com/shushuzn/ai_research_os/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/shushuzn/ai_research_os/actions)
[![License](https://img.shields.io/badge/License-GPL--3.0--or--later-orange)](#license)

## What It Does

AI Research OS is a **self-evolving research system** that learns from your usage patterns. It's not just a paper manager — it's a research partner that grows smarter over time.

Feed it a paper (arXiv URL, DOI, or PDF). Get back a **P-Note**, **C-Note**, **Radar entry**, and **Timeline entry** — all structured, tagged, and cross-linked.

| Input | Output |
|---|---|
| arXiv URL/ID | P-Note + C-Note + Radar + Timeline |
| DOI | P-Note + C-Note + Radar + Timeline |
| Local PDF | P-Note + C-Note + Radar + Timeline |
| Scanned PDF | Same (via OCR) |

This is **not a PDF manager**. It is a **Self-Evolving System** that:
- Learns from your research patterns
- Improves answers over time
- Adapts to your specific domain

## Core Features

| Feature | Description |
|---------|-------------|
| `airos import` | Import papers from arXiv, DOI, PDF |
| `airos chat` | RAG-powered Q&A with your papers |
| `airos slides` | Auto-generate presentations |
| `airos kg` | Knowledge graph visualization |
| Evolution | Self-improvement via Gene/Capsule patterns |

## Quick Start

```bash
pip install ai-research-os
airos-cli 2601.00155 --tags LLM,Agent
```

That's it — one paper imported in seconds. The above installs the package and imports an arXiv paper.

### One line, three inputs

```bash
airos-cli 2601.00155                          # arXiv ID
airos-cli 10.48550/arXiv.2601.00155           # DOI
airos-cli --pdf paper.pdf --tags RAG            # Local PDF
airos-cli --pdf scanned.pdf --ocr --ocr-lang chi_sim+eng   # Scanned PDF
```

### Three core commands

```bash
airos-cli import 2601.00155 10.1038/nature12373   # Add papers to DB
airos-cli search "attention mechanism" --tag LLM    # Search papers
airos-cli research "RLHF alignment" --limit 5       # Autonomous research loop
```

### AI draft (optional)

```bash
export OPENAI_API_KEY="***"
export OPENAI_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"
airos-cli 2601.00155 --tags LLM --ai
```

For full configuration, see [API_CONFIG.md](API_CONFIG.md).

## Research Tree

Papers are organized into 12 directories:

```
00-Radar/            Topic heat tracking
01-Foundations/      Foundational papers
02-Models/           Model papers
03-Training/         Training methods
04-Scaling/         Scaling laws
05-Alignment/        Alignment research
06-Agents/           Agent systems
07-Infrastructure/    Infrastructure
08-Optimization/     Optimization techniques
09-Evaluation/       Evaluation methods
10-Applications/     Applied research
11-Future-Directions/
```

## Installation

```bash
pip install ai-research-os
```

Or install from source:

```bash
git clone https://github.com/shushuzn/ai_research_os.git
cd ai_research_os
pip install -e .
```

## Documentation

Full documentation at [ai-research-os.readthedocs.io](https://ai-research-os.readthedocs.io/).

| Doc | Description |
|-----|-------------|
| [Architecture](docs/architecture.md) | System design and module overview |
| [Configuration](docs/configuration.md) | LLM, DB, Search, Tool configuration |
| [Benchmarks](docs/benchmarks.md) | Performance metrics and test coverage |
| [Contributing](CONTRIBUTING.md) | How to contribute to this project |
| [Roadmap](ROADMAP.md) | Project roadmap and future plans |

## License

GPL-3.0-or-later. See [LICENSE](LICENSE) for details.
