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 是一个面向科研的开源 AI 工作台:给它一个目标,它就会阅读文献、编写并运行代码、执行实验,并撰写研究发现。
这是桌面应用、CLI,还是两者都是?三者都是:macOS/Windows/Linux 桌面应用、浏览器工作区和终端 CLI,还有 SDK 支持集成。
怎么把它跑起来?下载适配你操作系统的桌面应用,或用一键启动器打开 CLI 和浏览器工作区,然后打开 Customize → Models 选择一种接入方式。
需要 API 密钥吗,还是可以用本地模型运行?你可以登录 Ace 使用托管模型,连接自己的提供商 API 密钥或登录凭证,或通过 Ollama、LM Studio 或其他兼容端点使用本地模型;如果使用自己的提供商或本地模型,OpenScience 账号是可选的。
Ace 怎么计费,有哪些要注意的?Ace 激活时会做一次 0 美元授权,用量按提供商上报的成本加收 5.5% 的资金费率计费;钱包自动充值功能会在余额低于 5 美元时自动充值 20 美元,而且切换到自己的提供商并不会关闭自动充值。
它总会先验证结果再采信吗?不会,README 建议在采信代理得出的任何科学结论之前,先审查来源、假设、代码和输出。
有什么可以复用的,不用从零写提示词?你可以浏览内置的数百个技能,它们描述了可复用的研究流程,也可以添加你自己项目的专属工作流。
怎么用自定义工具扩展 OpenScience?你可以添加 MCP 连接、自定义代理和命令、插件,或通过 SDK 集成,来扩展这个工作台的能力。
怎么更新已安装的版本?使用桌面应用的更新功能,CLI 运行 openscience upgrade,npm 安装的用 npm install -g @synsci/openscience@latest 更新。
Size
79 MB
Stars
4K
Age
3mo
Commits · 90 Days