Commit 18302135 authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

updated pacakge info

parent 1d1cb6d7
Loading
Loading
Loading
Loading
+35 −8
Original line number Diff line number Diff line
## CSST 
## csst_proto 
[![Documentation Status](https://readthedocs.org/projects/csst/badge/?version=latest)](https://csst.readthedocs.io/en/latest/?badge=latest)
 
CSST pipeline prototype.
CSST L1 pipeline prototype.

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

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

## install

## Install
```
git clone https://csst-tb.bao.ac.cn/code/hypergravity/csst_proto.git
`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
sh install.sh
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 import flip_image, print_data
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.

requirements.txt

0 → 100644
+5 −0
Original line number Diff line number Diff line
numpy~=1.20.3
joblib~=1.1.0
#csst~=0.0.1
setuptools~=58.0.4
astropy~=5.1
 No newline at end of file