Skip to content

Repository files navigation

CatMaster

中文 | English

CatMaster 是一个面向计算催化、材料建模、文献研究和科研写作的自主 Agent 工作台。它把对话、项目文件、领域 skills、可执行 tools、人工审批和受管远程计算放在同一个 workspace 中。用户可以从研究目标出发,不必先把工作拆成一串工具调用。

CatMaster is an autonomous agent workbench for computational catalysis, materials modeling, literature research, and scientific writing. It brings conversations, project files, domain skills, executable tools, approvals, and managed remote computation into one workspace. Users can begin with a research objective instead of scripting a sequence of tool calls.

从研究目标出发

CatMaster 可以直接从研究目标安排工作。Agent 会根据现有文件、科学约束和当前部署能力选择 skill,调用 tool,并检查中间产物。用户仍然决定会改变科学含义、花费远程算力或影响重要文件的事项。

WebUI 提供五个研究入口:

Agent 主要角色 能力来源举例 适合交付
Research 拆解开放研究目标并下发实际执行 可委派 Literature Review、Experiment、Writing、Peer Review,并读取项目文件、记忆与返回产物 已执行的文献、计算、写作和审稿阶段,证据地图与跨阶段结论
Experiment 组织有边界的建模、计算和验证 Materials、Dynamics、ML、ORCA/xTB workers,以及结构、计算、轨迹和远程执行 skills 结构候选、计算 stage、数据集、轨迹分析和结果合同
Literature Review 从论文发现走到可追溯证据 网页检索、受控浏览、本地语料、全文精读和引用核验 tools 与 skills 检索记录、证据表、双语精读、引用库和综述
Writing 把已有证据组织成科研交付物 论文写作、润色、引用、数据声明、图件、PPT、投稿回复和专利 skills Markdown、LaTeX、DOCX、PPTX、图件和 PDF
Peer Review 独立审查一份固定稿件 多 reviewer 模型、审稿 worker 和 peer_review_request 原始 reviewer reports、editor synthesis 和修订问题单

Research 负责方向判断,并把有边界的阶段交给能够执行的 specialist。在用户授权范围内,一项研究可以从文献证据缺口推进到结构建模、远程计算、结果复核、写作和独立审稿。具体操作由拥有相应 tools 与 skills 的 specialist 或 worker 完成。结果返回 workspace 后,Research 会核对证据,再决定补充验证还是收束结论。

需要跨 thread 延续、比较竞争解释或让一条结果影响多个假设时,可以建立 workspace 级 Research Graph。每个 graph 有显式研究问题和完成条件,永久图中只保存 Hypothesis、Experiment 和 Result 节点及其关系。用户可以直接录入猜想、实验 proposal,以及本项目、合作组或文献中的观察;外部 Result 不需要倒填一个虚假的 Experiment。论文、笔记、结构、报告和运行记录仍留在原有文件、artifact 和 receipt 中,通过引用连接到图。多个 thread 可以显式附着同一个 graph;删除或运行某个 thread 不会锁住它。Research planning 从 partial focus snippet 开始,并可通过绑定的只读 SQL 查询完整图状态。它把现有 runnable Experiment 与新候选路线放在同一轮临时评价中,为每个候选给出当前 revision 的创新分和保守分。分数不会写入永久 Experiment。manual 模式同时显示两种推荐,由用户选择;auto 模式默认采用明确的保守推荐,缺少有效评价或没有值得推进的路线时保持等待。staging 本身不会实体化或启动任何路线,未选分支也不会写入永久科学图。由图启动的计算仍遵守原有 specialist 分工、受管执行和人工审批。

Experiment 下的四类 worker 进一步分工:Materials 负责晶体、表面、吸附、缺陷、反应路径和性质计算;Dynamics 负责 AIMD、LAMMPS、MLFF MD、restart 与轨迹;ML 负责数据集、MACE 训练评估和主动学习;ORCA/xTB 负责分子、构象、xTB、CREST、ORCA、TS、IRC、TDDFT 与 NMR。

完整说明和可直接改写的参考 prompt 见中文用户手册。手册先解释 Agent 能完成的研究工作,再在可展开区域列出当前 tools 与 skills;远程 task 独立成章,不与结构准备混为一谈。

快速启动

conda env create -f requirements/pc-conda.yml
conda activate catmaster

cp -n configs/llm.template.yaml configs/llm.yaml
export OPENROUTER_API_KEY="<YOUR_KEY>"

mkdir -p "$HOME/catmaster_projects"
CATMASTER_PROJECT_SPACE_ROOT="$HOME/catmaster_projects" \
CATMASTER_HOST=127.0.0.1 \
CATMASTER_PORT=7991 \
./start_webui.sh

打开 http://127.0.0.1:7991,新建 workspace 和 thread,把权限模式设为 Review。在 Files 上传一份 CIF 或 POSCAR;源码安装可以使用 tests/assets/Fe.cif。然后先做一个不提交远程计算的任务:

使用 Experiment 检查我刚上传的晶体结构。
识别文件路径、材料、晶胞、元素和约束,检查周期边界下的异常短距,
生成一份结构审计报告并说明后续可以开展哪些建模。
不要修改原文件,也不要查询或提交远程任务。

如果管理员已经提供了 CatMaster 地址,可直接从第一次进入 WebUI开始。模型路由、服务器部署和外部程序配置集中在第 10 章

中文手册路线

Start from a research objective

CatMaster can plan work directly from a research objective. An agent interprets the existing files, scientific constraints, and deployment capabilities before selecting skills and calling tools. The user retains control over choices that change the scientific question, consume remote compute, or affect important files.

The WebUI exposes five research entries:

Agent Role Capability sources Typical deliverables
Research Decomposes open objectives and dispatches real execution Literature Review, Experiment, Writing, and Peer Review specialists, plus project files, memory, and returned artifacts Completed literature, computation, writing, and review stages; evidence maps; cross-stage conclusions
Experiment Organizes bounded modeling, computation, and validation Materials, Dynamics, ML, and ORCA/xTB workers with structure, calculation, trajectory, and remote-execution skills Candidate structures, calculation stages, datasets, trajectory analyses, result contracts
Literature Review Moves from discovery to traceable evidence Web search, controlled browsing, local corpora, full-paper reading, and citation-verification tools and skills Search records, evidence tables, readers, reference libraries, reviews
Writing Turns existing evidence into scientific deliverables Manuscript, polishing, citation, data, figure, slide, response, and patent skills Markdown, LaTeX, DOCX, PPTX, figures, PDF
Peer Review Independently assesses one fixed manuscript Multiple reviewer models, a review worker, and peer_review_request Raw reviewer reports, editor synthesis, revision issue lists

Research decides how to advance an open objective and delegates bounded stages to specialists that can execute them. Within the authority granted by the user, a study can move from a literature evidence gap to structure modeling, remote computation, result checks, writing, and independent review. Research checks returned evidence before it launches another stage or closes the question.

Studies that span threads, retain competing explanations, or share evidence can use a workspace Research Graph. Each graph has an explicit question and completion criterion; its durable scientific state contains Hypothesis, Experiment, and Result nodes with typed relationships. Users can enter ideas, experiment proposals, and observations from the project, collaborators, or literature; an external Result does not require an invented retrospective Experiment. Papers, notes, structures, reports, artifacts, and run receipts stay in their existing stores and connect through references. Planning starts from a partial focus snippet and can query the complete bound graph through a read-only SQL surface. Each planning revision compares existing runnable Experiments with newly proposed routes and gives every candidate a temporary innovation score and conservative score. These scores are never written into the durable Experiment. Manual mode shows both recommendations for user selection. Automatic mode uses an explicit conservative recommendation and waits when evaluation is missing, invalid, stale, or has no worthwhile route. Staging alone never materializes or launches a branch, and unselected branches do not enter the durable graph. A Writing thread attached to the graph uses the same partial context and read-only query surface to locate relevant Results, contrary evidence, and source references before opening the original files; it cannot edit the graph. Work launched from the graph still follows the ordinary specialist boundaries, managed execution, and approval rules.

Experiment delegates crystal, surface, adsorption, defect, path, and property work to Materials; AIMD, LAMMPS, MLFF MD, restart, and trajectory work to Dynamics; datasets, MACE, and active learning to ML; and molecular, conformer, xTB, CREST, ORCA, TS, IRC, TDDFT, and NMR work to ORCA/xTB.

The English user manual describes these capabilities as connected research work. Exact tool and skill names remain available in expandable reference sections. Remote tasks have a separate chapter because preparing a valid calculation and executing it on a configured machine are different capabilities.

English manual paths

The launch example binds a local installation to loopback. A shared deployment needs authentication, access control, and the operational configuration described in the manual.

Demo / 在线演示

A hosted demo may be available at https://cm.cccgg.cyou. Availability and compute capacity depend on the current deployment. Use a local or institution-managed installation for private data and substantial calculations.

在线 Demo 可能位于 https://cm.cccgg.cyou。在线状态和可用算力取决于当前部署。私有数据和正式计算应使用本地或机构管理的实例。

Acknowledgements and third-party software / 致谢与第三方软件

CatMaster 的主体代码采用 Apache License 2.0。以下项目为仓库中的 skill、参考材料或运行组件提供了直接来源。相关作者与许可证仍归各上游项目所有。

CatMaster's main code is released under the Apache License 2.0. The projects below directly supply skills, source material, or runtime components. Their authorship and license terms remain with the upstream projects.

Project or contributor Used in CatMaster Attribution and license
Yuan Yizhe's nature-skills Selected literature, reading, citation, writing, data, figure, review, response, and presentation skills Adapted under Apache-2.0; the redistributed license is at skills/NATURE_SKILLS_LICENSE
Siqi Chen's Humanizer Runtime writing-quality skill used for prose-heavy deliverables MIT; the unmodified upstream SKILL.md and license are retained at skills/writing_quality/humanizer
十五 (JL Lab), research-pipeline researchwrite, experiment logging, and related research workflow material MIT metadata retained in the relevant skills; see the researchwrite README
snipp-zha/Paper-to-patent-Skill Evidence-grounded Chinese patent drafting skill Contributor and source retained in the local nature-paper-to-patent README
figures4papers and Peng Sida's research notes Figure patterns and scientific-writing references Source notes are retained in the local nature-figure and unified nature-writing documentation
K-Dense scientific agent skills Scientific writing, visualization, citation management, and venue guidance MIT upstream; author metadata is retained in the bundled skill files
ScanSci PDF and CloakBrowser Layered scholarly PDF acquisition and the internal low-priority DOI-page fallback Apache-2.0 and MIT respectively; thank you to both projects and their contributors for making reliable full-text retrieval practical
MatterViz Primary materials 3D preview and Structure Workbench canvas Exact-pinned frontend dependency, MIT
Ketcher Lazy 2D molecule connection-table editor Exact-pinned ketcher-react and ketcher-core, Apache-2.0

The WebUI installs pinned JSmol 16.3.13 assets from the official Jmol package for OUTCAR vibration and compatibility fallback previews. Jmol/JSmol is distributed upstream under LGPLv2. JSmol is a viewer only; the primary MatterViz Workbench, calculation engines, and remote execution continue to work if its fallback assets are unavailable.

WebUI 会从 Jmol 官方发布包安装固定版本的 JSmol 16.3.13,用于 OUTCAR vibration 和兼容 fallback 预览。Jmol/JSmol 的上游许可证为 LGPLv2。JSmol 只负责 fallback;其资源缺失不会影响 MatterViz 主工作台、计算引擎或远程任务。

Core dependencies include DeepAgents, LangGraph, LangChain, FastAPI, Pydantic, React, assistant-ui, ASE, pymatgen, RDKit, and DPDispatcher. The exact Python and frontend dependency lists are maintained in requirements/pc-conda.yml and catmaster/webui/frontend/package.json.

核心依赖包括 DeepAgents、LangGraph、LangChain、FastAPI、Pydantic、React、assistant-ui、ASE、pymatgen、RDKit 和 DPDispatcher。完整的 Python 与前端依赖分别以 requirements/pc-conda.ymlcatmaster/webui/frontend/package.json 为准。

VASP, ORCA, CP2K, LAMMPS, xTB, CREST, VESTA, VASPKIT, and other scientific programs are configured separately. They are not licensed by CatMaster, and each deployment remains responsible for the applicable upstream license, citation, and site policy.

VASP、ORCA、CP2K、LAMMPS、xTB、CREST、VESTA、VASPKIT 等科学软件需要单独配置,不随 CatMaster 获得许可。部署者需要遵守各软件的许可证、引用要求和所在机构的使用规则。

About

No description, website, or topics provided.

Resources

Stars

13 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages