Loading README.md +11 −31 Original line number Diff line number Diff line ## csst_proto [](https://csst-proto.readthedocs.io/en/latest/?badge=latest) CSST L1 pipeline prototype. ## homepage This code is available at *CSST GitLab*: - [https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto](https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto). ## documentation A sphinx-based documentation is available at - [https://csst-proto.readthedocs.io/en/latest/](https://csst-proto.readthedocs.io/en/latest/) CSST 流水线原型,用于展示示例代码。 ## dependency - numpy~=1.20.3 - joblib~=1.1.0 - astropy~=5.1 - numpy==1.23.3 - scipy==1.9.2 - joblib==1.2.0 - astropy==5.1 - pytest==7.2.1 - coverage==7.2.1 - toml==0.10.2 ## installation Loading @@ -30,18 +23,18 @@ pip install -r requirements.txt python setup.py install ``` or a single-line command or a single-line command (the requirements are not installed automatically) ```bash sh -c "$(curl -fsSL https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto/-/raw/main/install.sh)" ``` ## instruction ## tutorial A simple example on how to use this package: ```python from csst_proto.api import flip_image from csst_proto import flip_image from astropy.io import fits # read an L0 image Loading @@ -53,16 +46,3 @@ img_flipped = flip_image(img=img) ## algorithm description The `csst_proto` uses an awesome algorithm based on `numpy.ndarray` indices to flip images. --- ## useful links - python packaging user guide: https://packaging.python.org/en/latest/ - packaging binary extensions (C/C++): https://packaging.python.org/en/latest/guides/packaging-binary-extensions - `setuptools`: https://packaging.python.org/en/latest/tutorials/installing-packages/ - gitlab CI/CD pipeline: https://docs.gitlab.com/ee/ci/pipelines/ - gitlab runners: https://docs.gitlab.com/runner/ - `sphinx`: https://www.sphinx-doc.org/en/master/index.html - markdown: https://www.markdownguide.org/ - restructured text: https://docutils.sourceforge.io/rst.html - readthedocs: https://readthedocs.io/ or https://rtfd.io/ Loading
README.md +11 −31 Original line number Diff line number Diff line ## csst_proto [](https://csst-proto.readthedocs.io/en/latest/?badge=latest) CSST L1 pipeline prototype. ## homepage This code is available at *CSST GitLab*: - [https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto](https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto). ## documentation A sphinx-based documentation is available at - [https://csst-proto.readthedocs.io/en/latest/](https://csst-proto.readthedocs.io/en/latest/) CSST 流水线原型,用于展示示例代码。 ## dependency - numpy~=1.20.3 - joblib~=1.1.0 - astropy~=5.1 - numpy==1.23.3 - scipy==1.9.2 - joblib==1.2.0 - astropy==5.1 - pytest==7.2.1 - coverage==7.2.1 - toml==0.10.2 ## installation Loading @@ -30,18 +23,18 @@ pip install -r requirements.txt python setup.py install ``` or a single-line command or a single-line command (the requirements are not installed automatically) ```bash sh -c "$(curl -fsSL https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto/-/raw/main/install.sh)" ``` ## instruction ## tutorial A simple example on how to use this package: ```python from csst_proto.api import flip_image from csst_proto import flip_image from astropy.io import fits # read an L0 image Loading @@ -53,16 +46,3 @@ img_flipped = flip_image(img=img) ## algorithm description The `csst_proto` uses an awesome algorithm based on `numpy.ndarray` indices to flip images. --- ## useful links - python packaging user guide: https://packaging.python.org/en/latest/ - packaging binary extensions (C/C++): https://packaging.python.org/en/latest/guides/packaging-binary-extensions - `setuptools`: https://packaging.python.org/en/latest/tutorials/installing-packages/ - gitlab CI/CD pipeline: https://docs.gitlab.com/ee/ci/pipelines/ - gitlab runners: https://docs.gitlab.com/runner/ - `sphinx`: https://www.sphinx-doc.org/en/master/index.html - markdown: https://www.markdownguide.org/ - restructured text: https://docutils.sourceforge.io/rst.html - readthedocs: https://readthedocs.io/ or https://rtfd.io/