Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
csst-pipeline
csst_proto
Commits
25c640da
Commit
25c640da
authored
Aug 23, 2022
by
BO ZHANG
🏀
Browse files
added standards.md
parent
7eb4a123
Pipeline
#27
canceled with stages
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
standards.md
0 → 100644
View file @
25c640da
## 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
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment