[![PyPI](https://img.shields.io/pypi/v/sunflare.svg?color=green)](https://pypi.org/project/sunflare)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sunflare)](https://pypi.org/project/sunflare)
[![codecov](https://codecov.io/gh/redsun-acquisition/sunflare/graph/badge.svg?token=XAL7NBIU9N)](https://codecov.io/gh/redsun-acquisition/sunflare)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

# 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.

## Contents

```{toctree}
:maxdepth: 1

statement
getting_started
overview/index
api/index
crash_course/index
changelog
```

## Indices and tables

- {ref}`genindex`
- {ref}`modindex`
- {ref}`search`

[redsun]: https://redsun-acquisition.github.io/redsun/
[bluesky]: https://blueskyproject.io/bluesky/main/index.html