Metadata-Version: 2.1
Name: kspec-gfa-controller
Version: 0.6.0
Summary: The Controller software for KSPEC-GFA Camera
Author: Mingyeong Yang
Author-email: mmingyeong@kasi.re.kr
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: astropy (>=6.1.2,<7.0.0)
Requires-Dist: asyncio (>=3.4.3,<4.0.0)
Requires-Dist: datetime (>=5.5,<6.0)
Requires-Dist: logging (>=0.4.9.6,<0.5.0.0)
Requires-Dist: pypylon (>=4.0.0,<5.0.0)
Description-Content-Type: text/markdown

# kspec_gfa_controller

![Versions](https://img.shields.io/badge/python-3.9+-blue)
![Ruff](https://github.com/mmingyeong/kspec_gfa_controller/actions/workflows/ruff.yml/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/kspec-gfa/badge/?version=latest)](https://kspec-gfa.readthedocs.io/en/latest/?badge=latest)

# The KSPEC GFA Camera Controller
- KSPEC-GFA is a tool for guiding, focusing, and acquisition sequence control in KSPEC observation.
- The Controller communicate with Basler Guide cameras for guiding and focusing processes.
- The Controller use the [pypylon](https://github.com/basler/pypylon) library as the middleware for the communication.

# Getting Started

## Installation

`kspec-gfa` can be installed using by cloning this repository

```console
git clone https://github.com/mmingyeong/kspec_gfa.git
```

## Quick Start

```console
cd kspec_gfa_controller/controller/main.py
python main.py
```

## Software Architecture

Here is the Software Architecture diagram explaining the hierarchy of KSPEC-GFA.

![img](./docs/sphinx/source/_static/kspec-gfa_software_architecture.png)
