Sunflare¶
Toolkit for Redsun development
Warning
This project is currently under active development and it may (and most likely will) receive breaking changes. Use at your own risk.
Sunflare is a Software Development Kit (SDK) which provides common, reusable components for building plugins which can interact with Redsun.
The aim is to provide reusable patterns in developing software applications for scientific device orchestration leveraging the Bluesky hardware interface and data model.
Getting Started¶
New to Sunflare? Start here:
-
Tutorials
Learn Sunflare from the ground up with step-by-step lessons
-
How-to Guides
Practical guides for common tasks and problems
-
Reference
Technical documentation and API reference
-
Explanation
Understand the concepts and design behind Sunflare
Quick Links¶
- Installation Guide - Get Sunflare up and running
- Statement of Need - Learn why Sunflare exists
- API Reference - Explore the complete API
- Changelog - See what's new
About the Documentation¶
This documentation follows the Diátaxis framework, organizing content into four distinct categories based on your needs:
- Tutorials are learning-oriented lessons
- How-to Guides are task-oriented recipes
- Reference is information-oriented technical descriptions
- Explanation is understanding-oriented discussions