Loading README.md +38 −7 Original line number Diff line number Diff line Loading @@ -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. --- ## timeline Loading @@ -68,12 +69,42 @@ The `csst_proto` uses an awesome algorithm based on `numpy.ndarray` indices to f | `setup.py` | sphinx-based documentation | √√ | √ | | ## important stages 1. **code**, **code style** & `top_level_interface` 2. **installation**: `source code` & `setup.py` -> `pip install <package_name>` 3. **a simple instruction**: `README.md` 4. **unittest**: `pytest` 5. *gitlab CI/CD pipeline: `.gitlab-ci.yml` 6. *sphinx-based documentation: `doc/` & `readthedocs.yml` - stage 1: - finished main code - good code style - `top_level_interface` available - stage 2: - 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 - python packaging user guide: https://packaging.python.org/en/latest/ Loading @@ -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 - readthedocs: https://readthedocs.io/ or https://rtfd.io/ ## `data manager` ## `data manager` for MS MBI ```python import os Loading Loading
README.md +38 −7 Original line number Diff line number Diff line Loading @@ -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. --- ## timeline Loading @@ -68,12 +69,42 @@ The `csst_proto` uses an awesome algorithm based on `numpy.ndarray` indices to f | `setup.py` | sphinx-based documentation | √√ | √ | | ## important stages 1. **code**, **code style** & `top_level_interface` 2. **installation**: `source code` & `setup.py` -> `pip install <package_name>` 3. **a simple instruction**: `README.md` 4. **unittest**: `pytest` 5. *gitlab CI/CD pipeline: `.gitlab-ci.yml` 6. *sphinx-based documentation: `doc/` & `readthedocs.yml` - stage 1: - finished main code - good code style - `top_level_interface` available - stage 2: - 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 - python packaging user guide: https://packaging.python.org/en/latest/ Loading @@ -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 - readthedocs: https://readthedocs.io/ or https://rtfd.io/ ## `data manager` ## `data manager` for MS MBI ```python import os Loading