内容
# 鹰
[](https://github.com/als-apg/osprey/actions/workflows/ci.yml)
[](https://pypi.org/project/osprey-framework/)
[](https://www.python.org/downloads/)
[](LICENSE.txt)
[](https://doi.org/10.1063/5.0306302)
**适用于安全关键控制系统的代理接口和安全防护。**
鹰解决了控制系统特有的挑战:大型通道命名空间的语义寻址、与控制堆栈的协议无关的集成、跨设施电子日志的智能日志簿搜索,以及对每个硬件写入的强制人工监督。
为粒子加速器、聚变实验、光束线和大型科学设施而设计。
<p align="center">
<img src="docs/source/_static/resources/architecture.png" width="100%"
alt="鹰系统架构,从操作员到设施,安全门和审批工作流在线。" />
</p>
## 快速开始
```bash
# 安装框架作为独立的CLI工具(使用uv,推荐)
uv tool install osprey-framework
# 创建一个最小项目以验证您的设置
osprey build quickstart --preset hello-world
cd quickstart
# 如果环境中没有API密钥,请复制并编辑.env:
# cp .env.example .env
# 启动代理会话
claude
```
对于针对您的探测器、光束线或加速器子系统量身定制的项目,请安装引导构建-采访技能,并从代理会话中运行它:
```bash
osprey skills install osprey-build-interview
```
然后在空目录中启动代理并输入 `/osprey-build-interview`。技能会引导您完成对话,生成构建配置文件,`osprey build profile.yml` 生成一个可立即使用的项目。
## 关键功能
- **代理驱动的编排** — 技能、MCP工具和显式依赖声明让鹰代理可以将操作员请求分解为可审计的步骤,并带有强制性的审批门控。
- **控制系统安全** — 模式检测、通道边界检查和每个硬件写入的强制人工审批。
- **协议无关的集成** — EPICS和Mock连接器在树中提供;LabVIEW、Tango和其他堆栈通过[连接器接口](https://als-apg.github.io/osprey/how-to/add-connector.html)连接。
- **可替换的后端** — 代理托管、底层模型和计算后端均可通过配置进行更换,而无需更改操作员看到的内容。
- **可扩展的能力管理** — 动态分类可防止随着工具集的增长而出现提示爆炸。
## 文档
**[阅读完整文档 →](https://als-apg.github.io/osprey)**
鹰遵循CalVer(`vYYYY.M.P`)。公共API可能在版本之间发生变化 — 固定版本并在升级前检查[变更日志](CHANGELOG.md)。
## 贡献
欢迎贡献。请参阅[贡献指南](CONTRIBUTING.md)以获取开发设置、编码标准和拉取请求工作流程。要报告安全问题,请遵循[安全策略](SECURITY.md)而不是打开公共问题。
## 引用
如果您在研究中使用鹰,请引用[论文](https://doi.org/10.1063/5.0306302)。GitHub的**引用此仓库**按钮在侧边栏中直接导出BibTeX和APA。
## 许可证
BSD 3-Clause — 请参阅[LICENSE.txt](LICENSE.txt)。其他通知,包括美国能源部的保留权利和伯克利实验室的增强赠与,参见[NOTICE](NOTICE)。
版权(c)2025,加利福尼亚大学董事会,通过劳伦斯伯克利国家实验室(须接受美国能源部的任何必要批准)。保留所有权利。
关于使用或分发该软件的权利问题,请联系伯克利实验室知识产权办公室,邮箱:IPO@lbl.gov。