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
8b260d62
Commit
8b260d62
authored
Aug 24, 2022
by
BO ZHANG
🏀
Browse files
updated README.md
parent
b96c36da
Pipeline
#57
passed with stages
in 9 seconds
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
8b260d62
...
...
@@ -45,3 +45,23 @@ img_flipped = flip_image(img=img)
## algorithm description
The
`csst_proto`
uses an awesome algorithm based on
`numpy.ndarray`
indices to flip images.
## timeline
| file / directory | description | notes | C6 | C7 |
|--------------------|---------------------------------|-------|-----|-----|
|
`csst_proto`
| source code & data | | √ | |
|
`doc`
| sphinx-based documentation | | | √ |
|
`example`
| code examples | | - | - |
|
`tests`
| unit tests | | | √ |
|
`.gitignore`
| git file | | √ | |
|
`.gitlab-ci.yml`
| gitlab CI/CD pipeline | | | √ |
|
`LICENSE`
| code license | | √ | |
|
`README.md`
| readme file | | √ | |
|
`install.sh`
| single-line installation script | | √ | |
|
`install_local.sh`
| local installation script | | √ | |
|
`readthedocs.yml`
| readthedocs.io configuration | | | √ |
|
`requirements.txt`
| code requirements | | √ | |
|
`setup.py`
| sphinx-based documentation | | √ | |
standards.md
deleted
100644 → 0
View file @
b96c36da
## 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