Commit 8b260d62 authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

updated README.md

parent b96c36da
Pipeline #57 passed with stages
in 9 seconds
......@@ -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 | | √ | |
## 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
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment