openscience README

The project's README from github.com/synthetic-sciences/openscience. As one markdown file: README.md.

OpenScience

The open-source AI workbench for scientific research

Give it a goal. It reads the literature, writes and runs code, runs the experiments, and writes up what it found.


CI npm release license

Get started · Documentation · Releases · Contributing


OpenScience is an open-source workbench for scientific research. Work through literature, data, code, experiments, and writing in the desktop app, browser workspace, or terminal.

Choose Ace for managed models and research search, connect your own API keys or supported provider sign-in, or use local models. An OpenScience account is optional for your own provider access and local models.

Get started

Download the desktop app for macOS, Windows, or Linux. For the CLI and browser workspace:

npm install -g @synsci/openscience
openscience

Or use the one-step launcher:

npx synsci

Open Customize → Models to choose access. For an existing project:

openscience ~/research/my-project

Follow the quickstart for your first task, or the installation guide for platform details and updates.

Choose model access

Option Setup Usage
Ace Sign in, choose a funding workspace, and fund its Wallet. Pay as you go; no monthly subscription.
Your provider Connect an API key or supported sign-in. Your provider's access and billing terms.
Local model Connect Ollama, LM Studio, or another compatible endpoint. Your hardware; no Ace model charge.

Ace activation is a $0 authorization. Usage is settled from the provider's reported cost plus a 5.5% funding fee, applied once per request, with no other markup; the card processing fee is shown separately at checkout. While automatic reloads are enabled, a purchased Wallet balance below $5 triggers a $20 reload. Changing to your own provider does not turn off automatic reloads. See Pricing and usage.

Connect from the terminal:

openscience keys add
openscience models

For a local endpoint:

openscience local add

See Models and Local models.

Give it a research task

Inspect data/samples.csv for missing values and inconsistent labels.
Keep the original data unchanged. Save a quality report and a plot
in results/, with the code needed to reproduce them.

Use Research for execution, or start with /plan to agree on the method. Review sources, assumptions, code, and outputs before relying on a scientific conclusion.

For a single terminal turn:

openscience run "Review the analysis plan in this project"
openscience run --continue "Suggest checks for the assumptions you identified"

What you can do

A skill describes a procedure; it does not mean every referenced tool or service is installed. Check availability in Customize before a substantial task.

Documentation

Browse the capability map, Explore tools, and Skills directory. Each catalog explains what an entry does and links to setup or usage instructions. The workflow cookbook provides complete requests with expected deliverables.

Topic Guide
First use Quickstart, Workspace
Models and billing Models, Ace, Pricing
Research Literature reviews, Data analysis, Reproduction, Writing
Capabilities Skills, Databases, Connectors
Customize Project instructions, Configuration
Automate CLI reference, JSON output, SDK and editors
Help Troubleshooting, FAQ

Plain-text documentation is available at llms.txt and llms-full.txt.

Releases and updates

GitHub Releases contains desktop installers, CLI archives, checksums, and release notes. The changelog records notable behavior changes.

Use the app's update controls or openscience upgrade for the CLI. An npm installation can be updated with npm install -g @synsci/openscience@latest. Back up important project files independently of application updates.

Development

Use the pinned Bun version from package.json:

bun run setup
bun dev
bun run check

CONTRIBUTING.md covers the development loop and required checks. ARCHITECTURE.md maps the codebase, and AGENTS.md describes repository conventions.

For docs changes, see the docs contributor guide and documentation source map.

Control and support

Use the approval controls to decide when OpenScience should ask before acting. Keep original inputs, review consequential actions, and use account controls for spending limits.

Report reproducible product bugs in GitHub Issues. Use account support for private billing questions. Follow SECURITY.md to report a vulnerability.

License

Apache License 2.0. See LICENSE and NOTICE.

OpenScience is an independent project. It is not affiliated with, endorsed by, or sponsored by Anthropic. "Claude" is a trademark of Anthropic, PBC, used here only to describe compatibility.

openscience (synthetic-sciences/openscience)

Searching Database…

Что это такое?OpenScience — это open-source AI-среда для научных исследований: дайте ей цель, и она читает литературу, пишет и запускает код, проводит эксперименты и описывает то, что обнаружила.
Это десктопное приложение, CLI или и то и другое?Здесь есть всё: десктопное приложение для macOS/Windows/Linux, рабочая среда в браузере и CLI для терминала, плюс SDK для интеграций.
Как это запустить?Скачайте десктопное приложение для своей ОС или используйте лаунчер в один шаг для CLI и браузерной среды, затем откройте Customize → Models и выберите вариант доступа.
Нужен ли API-ключ или можно запустить на локальных моделях?Можно войти в Ace для управляемых моделей, подключить API-ключ или вход своего провайдера либо использовать локальные модели через Ollama, LM Studio или другой совместимый эндпоинт; аккаунт OpenScience необязателен, если вы используете своего провайдера или локальные модели.
Как устроена оплата в Ace и на что обратить внимание?Активация Ace — это авторизация на $0, а использование тарифицируется как заявленная провайдером стоимость плюс сбор 5,5%; автоматическое пополнение Wallet срабатывает на $20, как только баланс опустится ниже $5, и переход на своего провайдера не отключает автопополнение.
Всегда ли он проверяет результаты, прежде чем доверять им?Нет, README советует проверять источники, допущения, код и выводы, прежде чем полагаться на любой научный вывод, который выдаёт агент.
Что можно переиспользовать вместо написания промптов с нуля?Можно просмотреть сотни встроенных skills, описывающих переиспользуемые исследовательские процедуры, или добавить собственный воркфлоу под свой проект.
Как расширить OpenScience кастомными инструментами?Можно добавить MCP-подключения, кастомных агентов и команды, плагины или интегрироваться через SDK, чтобы расширить возможности среды.
Как обновить существующую установку?Используйте средства обновления десктопного приложения, выполните openscience upgrade для CLI или обновите npm-установку командой npm install -g @synsci/openscience@latest.
Size
79.1 MB
Stars
4.1K
Age
3mo
Commits · 90 Days