Skip to content

sunflare

PyPI PyPI - Python Version codecov Ruff Checked with mypy License

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.

  • Tutorials

    Learn Sunflare from the ground up with step-by-step lessons.

    Start learning

  • How-to guides

    Practical guides for common tasks and problems.

    Browse guides

  • Reference

    Technical documentation and API reference.

    View reference

  • Explanations

    Understand the concepts and design behind Sunflare

    Read explanations

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.
  • Explanations is understanding-oriented discussions.