README.md

## csst_proto 
[![Documentation Status](https://readthedocs.org/projects/csst/badge/?version=latest)](https://csst.readthedocs.io/en/latest/?badge=latest)
 
CSST L1 pipeline prototype.

## homepage
*Gitlab*: [https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto](https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto)


## install

`csst_proto` can be installed with the following shell command

```bash
git clone https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto.git
cd csst_proto
pip install -r requirements.txt
python setup.py install
```

or a single-line command

```bash
sh -c "$(curl -fsSL https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto/-/raw/main/install.sh)"
```

## instruction

A simple example on how to use this package:

```python
import numpy as np
from csst_proto.top_level_interface import flip_image, read_test_image
from astropy.io import fits

# read an L0 image
img = fits.getdata("CSST_L0_img.fits")
# flip the image
img_flipped = flip_image(img=img)
```

## algorithm

The `csst_proto` uses an awesome algorithm based on `numpy.ndarray` indices to flip images.