Skip to content
GitLab
Switch branch/tag
Find file Normal viewHistoryPermalink
standards.md 689 Bytes
Newer Older
BO ZHANG's avatar
added standards.md  
BO ZHANG committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53 
## CSST L1 Pipeline Standards

### Workplace

Gitlab Group **CSST-L1**:
https://csst-tb.bao.ac.cn/code/csst-l1

### Prototype

https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto

### Structure of files

An example of the tree

```bash
csst_proto
 |-csst_proto
 |  |-data
 |  |  |-test_image.txt
 |  |  |-table_data.txt
 |  |-__init__.py
 |  |-flip_image.py
 |  |-some_other_modules.py
 |  |-top_level_interface.py
 |-tests
 |-doc (sphinx directory)
 |-setup.py
 |-LICENSE
 |-README.md
```


1. `setup.py`
    this file 

2.

### Code style

PEP8.

### Documentation

sphinx-based documentation needs docstrings.

1. docstring styles
    - Numpy (recommended)
    - Google

### Unit Tests