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
5680f4c8
Commit
5680f4c8
authored
Aug 25, 2022
by
BO ZHANG
🏀
Browse files
updated README.md
parent
5490b349
Pipeline
#67
passed with stages
in 11 seconds
Changes
1
Pipelines
1
Show whitespace changes
Inline
Side-by-side
README.md
View file @
5680f4c8
...
@@ -48,6 +48,7 @@ img_flipped = flip_image(img=img)
...
@@ -48,6 +48,7 @@ img_flipped = flip_image(img=img)
The
`csst_proto`
uses an awesome algorithm based on
`numpy.ndarray`
indices to flip images.
The
`csst_proto`
uses an awesome algorithm based on
`numpy.ndarray`
indices to flip images.
---
## timeline
## timeline
...
@@ -68,12 +69,42 @@ The `csst_proto` uses an awesome algorithm based on `numpy.ndarray` indices to f
...
@@ -68,12 +69,42 @@ The `csst_proto` uses an awesome algorithm based on `numpy.ndarray` indices to f
|
`setup.py`
| sphinx-based documentation | √√ | √ | |
|
`setup.py`
| sphinx-based documentation | √√ | √ | |
## important stages
## important stages
1.
**code**
,
**code style**
&
`top_level_interface`
-
stage 1:
2.
**installation**
:
`source code`
&
`setup.py`
->
`pip install <package_name>`
-
finished main code
3.
**a simple instruction**
:
`README.md`
-
good code style
4.
**unittest**
:
`pytest`
-
`top_level_interface`
available
5.
*
gitlab CI/CD pipeline:
`.gitlab-ci.yml`
-
stage 2:
6.
*
sphinx-based documentation:
`doc/`
&
`readthedocs.yml`
-
finished
`setup.py`
-
can be installed with
`pip install <package_name/package_link>`
from gitlab
-
stage 3:
-
finished instruction
-
`README.md`
-
stage 4:
-
finished unittest
-
local unit test passed with
`pytest`
-
stage 5:
-
gitlab CI/CD pipeline available
-
auto unit tests passed with
`.gitlab-ci.yml`
-
stage 6:
-
*
sphinx-based documentation available
-
`doc/`
-
`readthedocs.yml`
## progress
| module name | stage 1
<br>
(source code) | stage 2
<br>
(installation) | stage 3
<br>
(instruction) | stage 4
<br>
(unit tests) | stage 5
<br>
(gitlab pipeline) | stage 6
<br>
(sphinx doc) |
|--------------------------|--------------------------|---------------------------|--------------------------|-------------------------|------------------------------|-------------------------|
|
`csst_proto`
| √ | √ | √ | √ | √ | √ |
|
`csst_ms_mbi_instrument`
| | | | | | |
|
`csst_ms_mbi_distortion`
| √ | √ | √ | | | |
|
`csst_ms_mbi_position`
| | | | | | |
|
`csst_ms_mbi_flux`
| | | | | | |
|
`csst_ms_mbi_photometry`
| | | | | | |
|
`` | | | | | | |
| ``
| | | | | | |
|
`` | | | | | | |
## useful links
## useful links
- python packaging user guide: https://packaging.python.org/en/latest/
- python packaging user guide: https://packaging.python.org/en/latest/
...
@@ -95,7 +126,7 @@ The `csst_proto` uses an awesome algorithm based on `numpy.ndarray` indices to f
...
@@ -95,7 +126,7 @@ The `csst_proto` uses an awesome algorithm based on `numpy.ndarray` indices to f
- restructured text: https://docutils.sourceforge.io/rst.html
- restructured text: https://docutils.sourceforge.io/rst.html
- readthedocs: https://readthedocs.io/ or https://rtfd.io/
- readthedocs: https://readthedocs.io/ or https://rtfd.io/
## `data manager`
## `data manager`
for MS MBI
```python
```python
import os
import os
...
...
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