README.md 1.08 KB
Newer Older
BO ZHANG's avatar
BO ZHANG committed
1
## csst_common 
BO ZHANG's avatar
BO ZHANG committed
2
3
4
5
6
7
8
[![Documentation Status](https://readthedocs.org/projects/csst-proto/badge/?version=latest)](https://csst-proto.readthedocs.io/en/latest/?badge=latest)
 
CSST L1 pipeline prototype.

## homepage

This code is available at *CSST GitLab*:
BO ZHANG's avatar
BO ZHANG committed
9
- [https://csst-tb.bao.ac.cn/code/csst-l1/csst_common](https://csst-tb.bao.ac.cn/code/csst-l1/csst_common).
BO ZHANG's avatar
BO ZHANG committed
10
11
12
13
14
15
16
17
18
19
20
21
22
23

## documentation

A sphinx-based documentation is available at
- [https://csst-proto.readthedocs.io/en/latest/](https://csst-proto.readthedocs.io/en/latest/)

## dependency

- numpy~=1.20.3
- joblib~=1.1.0
- astropy~=5.1

## installation

BO ZHANG's avatar
BO ZHANG committed
24
`csst_common` can be installed with the following shell command
BO ZHANG's avatar
BO ZHANG committed
25
26

```bash
BO ZHANG's avatar
BO ZHANG committed
27
28
git clone https://csst-tb.bao.ac.cn/code/csst-l1/csst_common.git
cd csst_common
BO ZHANG's avatar
BO ZHANG committed
29
30
31
32
33
34
35
pip install -r requirements.txt
python setup.py install
```

or a single-line command

```bash
BO ZHANG's avatar
BO ZHANG committed
36
sh -c "$(curl -fsSL https://csst-tb.bao.ac.cn/code/csst-l1/csst_common/-/raw/main/install.sh)"
BO ZHANG's avatar
BO ZHANG committed
37
38
39
40
```

## instruction

BO ZHANG's avatar
BO ZHANG committed
41
how to import CSST parameters:
BO ZHANG's avatar
BO ZHANG committed
42
```python
BO ZHANG's avatar
BO ZHANG committed
43
44
45
from csst_common.params import CSST_PARAMS as CP
print(CP)
print(CP["mbi"]["detector2filter"])
BO ZHANG's avatar
BO ZHANG committed
46
```