From 183021355a769d82477febd5b51608ad423e75ee Mon Sep 17 00:00:00 2001
From: BO ZHANG <bozhang@nao.cas.cn>
Date: Tue, 23 Aug 2022 14:25:24 +0800
Subject: [PATCH] updated pacakge info

---
 README.md        | 43 +++++++++++++++++++++++++++++++++++--------
 requirements.txt |  5 +++++
 2 files changed, 40 insertions(+), 8 deletions(-)
 create mode 100644 requirements.txt

diff --git a/README.md b/README.md
index af211e6..1dfb87a 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,44 @@
-## 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.
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..5afcfb3
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,5 @@
+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
-- 
GitLab