Getting Started#
Welcome to Osprey Framework! This comprehensive guide will take you from zero to building production-ready control system agents, with working results at every step.
What You’ll Accomplish#
By following this comprehensive learning path, you’ll have:
A fully functional development environment
Your first working agent (weather assistant)
Production-grade control system patterns (control assistant)
Framework mastery through essential development patterns
Complete API reference for daily development
Prerequisites
Python 3.11+ installed
Basic Python knowledge
Terminal/command line familiarity
Text editor or IDE
Your Learning Path#
Get your development environment running with Podman, dependencies, and configuration. Includes interactive CLI for easy project creation!
Outcome: Working dev environment
Build a mental model of how Osprey and its applications work, before diving into code.
Outcome: Prepared mind for your Osprey journey
Build your first agent with a mock control system — one MCP server, zero complexity.
Outcome: Your first working agent
Generate a project profile for your own detector, beamline, or accelerator subsystem through a guided conversation.
Outcome: A tailored project for your facility
Production control system patterns with channel finding pipelines and comprehensive tooling.
Outcome: Enterprise integration patterns
Task-oriented guides for connectors, MCP servers, providers, and more.
Outcome: Practical recipes
Understand the Claude Code + MCP architecture, data flow, and key concepts.
Outcome: Architecture understanding