Skip to main content

An open-source, domain-agnostic, capability-based architecture for building intelligent agents

Project description

Osprey Framework

CI Documentation codecov PyPI version Python 3.11+ License

🎉 Latest Release: v2026.5.0 - CalVer adoption, doc-executability CI gate, deploy skill & friction logging

🚧 Early Access Release This is an early access version of the Osprey Framework. While the core functionality is stable and ready for experimentation, documentation and APIs may still evolve. We welcome feedback and contributions!

A production-ready framework for deploying agentic AI in large-scale, safety-critical control system environments—particle accelerators, fusion experiments, beamlines, and complex scientific facilities.

📄 Research This work was presented as a contributed oral presentation at ICALEPCS'25 and will be featured at the Machine Learning and the Physical Sciences Workshop at NeurIPS 2025.

🚀 Quick Start

# Install the framework as a standalone CLI tool (using uv, recommended)
uv tool install osprey-framework

# Create a minimal project to verify your setup
osprey build quickstart --preset hello-world
cd quickstart

# If API keys aren't already in your environment, copy and edit .env:
# cp .env.example .env

# Start a Claude Code agent session
claude

For a production project tailored to your detector, beamline, or accelerator subsystem, install the guided build-interview skill and run it from Claude Code:

# Install the /build-interview skill into ~/.claude/skills/
uv run osprey skills install build-interview

Then start Claude Code in an empty directory and type /build-interview. The skill walks you through a guided conversation, produces a build profile, and osprey build profile.yml generates a ready-to-use project.

📚 Documentation

📖 Read the Full Documentation →

🧪 Testing

# Run unit tests (fast, no API keys required)
pytest tests/ --ignore=tests/e2e -v

# Run e2e tests (slow, requires API keys)
# ⚠️ IMPORTANT: Use 'pytest tests/e2e/' NOT 'pytest -m e2e'
pytest tests/e2e/ -v

See TESTING_GUIDE.md and tests/e2e/README.md for details.

Key Features

  • Dual-Mode Orchestration - Plan-first (complete upfront plans) and reactive (ReAct, step-by-step) execution with explicit dependencies and operator oversight
  • Control-System Safety - Pattern detection, PV boundary checking, and mandatory approval for hardware writes
  • Protocol-Agnostic Integration - Seamless connection to EPICS, LabVIEW, Tango, and mock environments
  • Scalable Capability Management - Dynamic classification prevents prompt explosion as toolsets grow
  • Production-Proven - Deployed at major facilities including LBNL's Advanced Light Source accelerator

📖 Citation

If you use the Osprey Framework in your research or projects, please cite our paper:

@article{10.1063/5.0306302,
      author = {Hellert, Thorsten and Montenegro, João and Sulc, Antonin},
      title = {Osprey: Production-ready agentic AI for safety-critical control systems},
      journal = {APL Machine Learning},
      volume = {4},
      number = {1},
      pages = {016103},
      year = {2026},
      month = {02},
      doi = {10.1063/5.0306302},
      url = {https://doi.org/10.1063/5.0306302},
}

For detailed installation instructions, tutorials, and API reference, please visit our complete documentation.


Copyright Notice

Osprey Framework Copyright (c) 2025, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.

If you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Intellectual Property Office at IPO@lbl.gov.

NOTICE. This Software was developed under funding from the U.S. Department of Energy and the U.S. Government consequently retains certain rights. As such, the U.S. Government has been granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, distribute copies to the public, prepare derivative works, and perform publicly and display publicly, and to permit others to do so.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

osprey_framework-2026.5.0.tar.gz (15.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

osprey_framework-2026.5.0-py3-none-any.whl (2.5 MB view details)

Uploaded Python 3

File details

Details for the file osprey_framework-2026.5.0.tar.gz.

File metadata

  • Download URL: osprey_framework-2026.5.0.tar.gz
  • Upload date:
  • Size: 15.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for osprey_framework-2026.5.0.tar.gz
Algorithm Hash digest
SHA256 a427c39eb389cda0d5708072ccf049087f7f9a1fc9704bad820173a0fb4cfae2
MD5 5c0775d9cfabad59a1788d02d9cb5e5d
BLAKE2b-256 78cd576b9079684c46db4a7e4004ab0b96264cc660e46dbe6c6d21415db79340

See more details on using hashes here.

Provenance

The following attestation bundles were made for osprey_framework-2026.5.0.tar.gz:

Publisher: release.yml on als-apg/osprey

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file osprey_framework-2026.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for osprey_framework-2026.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fa96d46aa340b8da19cf044842e3e311a5bd20d5d0f8491a4fb4cac4f2b26028
MD5 ef0852d79b57ead06cdbccf7897abe5d
BLAKE2b-256 0142669ed3d5cc18e9c125d4a9e2b777762a86757f7add787bb740f32a53b334

See more details on using hashes here.

Provenance

The following attestation bundles were made for osprey_framework-2026.5.0-py3-none-any.whl:

Publisher: release.yml on als-apg/osprey

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page