diff --git a/README.md b/README.md index 87bbe05f9344ea0f4deb401124c5f6593aea7814..520100300c2c40f46a4588c4b34fe9aaf5c0991a 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ sh -c "$(curl -fsSL https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto/-/raw/main A simple example on how to use this package: ```python -from csst_proto.top_level_interface import flip_image +from csst_proto.api import flip_image from astropy.io import fits # read an L0 image diff --git a/csst_proto/top_level_interface.py b/csst_proto/api.py similarity index 100% rename from csst_proto/top_level_interface.py rename to csst_proto/api.py diff --git a/doc/source/api_changes.rst b/doc/source/api_changes.rst deleted file mode 100644 index 8107f55e7a5d5ca697dbcbc2e9f70cd93df3fec1..0000000000000000000000000000000000000000 --- a/doc/source/api_changes.rst +++ /dev/null @@ -1,11 +0,0 @@ -C7主巡天流水线接口 -================ - -Change list - - ``top_level_interface.py`` 文件改名为``api.py``, 这个文件中用于导入每个python package与流水线的接口函数 - - 接口定义更新, 每个开发模块需要把接口函数命名为``base_``开头的函数，例如``base_phot`` - -Example - - .. code-block:: python - def base_distortion(input_file, output_file, ) diff --git a/doc/source/vcs/create_merge_request.png b/doc/source/vcs/create_merge_request.png deleted file mode 100644 index 9c32c61517e4da0f8b0211b2e679bfe909193ddc..0000000000000000000000000000000000000000 Binary files a/doc/source/vcs/create_merge_request.png and /dev/null differ diff --git a/doc/source/vcs/merge_approve.png b/doc/source/vcs/merge_approve.png deleted file mode 100644 index 41035c854efbc60d1e4ef0d594cf2737620ccaf5..0000000000000000000000000000000000000000 Binary files a/doc/source/vcs/merge_approve.png and /dev/null differ diff --git a/doc/source/vcs/merge_request.png b/doc/source/vcs/merge_request.png deleted file mode 100644 index 45575e6a5f6c4a1b7154283ac53240107265c93a..0000000000000000000000000000000000000000 Binary files a/doc/source/vcs/merge_request.png and /dev/null differ diff --git a/doc/source/vcs/merged.png b/doc/source/vcs/merged.png deleted file mode 100644 index 994066af125d70031c31ed63d4e1546e42ca01f0..0000000000000000000000000000000000000000 Binary files a/doc/source/vcs/merged.png and /dev/null differ diff --git a/doc/source/vcs/pushed_to_dev.png b/doc/source/vcs/pushed_to_dev.png deleted file mode 100644 index fc0694ab0e1f69ed91a0ffbc65ab9f903c440053..0000000000000000000000000000000000000000 Binary files a/doc/source/vcs/pushed_to_dev.png and /dev/null differ diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/apidoc.sh b/docs/apidoc.sh similarity index 100% rename from doc/apidoc.sh rename to docs/apidoc.sh diff --git a/doc/latexpdf.sh b/docs/latexpdf.sh similarity index 100% rename from doc/latexpdf.sh rename to docs/latexpdf.sh diff --git a/doc/make.bat b/docs/make.bat similarity index 100% rename from doc/make.bat rename to docs/make.bat diff --git a/doc/preview.sh b/docs/preview.sh similarity index 100% rename from doc/preview.sh rename to docs/preview.sh diff --git a/doc/requirements.txt b/docs/requirements.txt similarity index 100% rename from doc/requirements.txt rename to docs/requirements.txt diff --git a/doc/source/_static/custom.css b/docs/source/_static/custom.css similarity index 100% rename from doc/source/_static/custom.css rename to docs/source/_static/custom.css diff --git a/doc/source/_static/logo-wordmark-light.svg b/docs/source/_static/logo-wordmark-light.svg similarity index 100% rename from doc/source/_static/logo-wordmark-light.svg rename to docs/source/_static/logo-wordmark-light.svg diff --git a/doc/source/api/csst_proto.rst b/docs/source/api/csst_proto.rst similarity index 100% rename from doc/source/api/csst_proto.rst rename to docs/source/api/csst_proto.rst diff --git a/docs/source/c7_changes.rst b/docs/source/c7_changes.rst new file mode 100644 index 0000000000000000000000000000000000000000..27341410a3dbe9212ed8eae88c31388358492290 --- /dev/null +++ b/docs/source/c7_changes.rst @@ -0,0 +1,15 @@ +C7主巡天流水线接口 +================ + +Change list + - 接口文件修改： + ``top_level_interface.py`` 文件改名为 ``api.py`` , 这个文件中用于导入每个 python package 与流水线的接口函数 + - 接口名称修改： + 每个开发模块需要把接口函数命名为 ``base_`` 开头的函数，例如 ``base_phot`` + - 接口定义修改： + 样例代码如下 + + .. code-block:: python + + def base_distortion(input_file, output_file, rc="./gaia_dr3.fits") -> : + return diff --git a/doc/source/ch01_team.rst b/docs/source/ch01_team.rst similarity index 100% rename from doc/source/ch01_team.rst rename to docs/source/ch01_team.rst diff --git a/doc/source/ch02_vcs.rst b/docs/source/ch02_vcs.rst similarity index 100% rename from doc/source/ch02_vcs.rst rename to docs/source/ch02_vcs.rst diff --git a/doc/source/ch03_packaging.rst b/docs/source/ch03_packaging.rst similarity index 100% rename from doc/source/ch03_packaging.rst rename to docs/source/ch03_packaging.rst diff --git a/doc/source/ch04_codestyle.rst b/docs/source/ch04_codestyle.rst similarity index 100% rename from doc/source/ch04_codestyle.rst rename to docs/source/ch04_codestyle.rst diff --git a/doc/source/ch05_preference.rst b/docs/source/ch05_preference.rst similarity index 100% rename from doc/source/ch05_preference.rst rename to docs/source/ch05_preference.rst diff --git a/doc/source/ch06_unittest.rst b/docs/source/ch06_unittest.rst similarity index 100% rename from doc/source/ch06_unittest.rst rename to docs/source/ch06_unittest.rst diff --git a/doc/source/ch07_simulation.rst b/docs/source/ch07_simulation.rst similarity index 100% rename from doc/source/ch07_simulation.rst rename to docs/source/ch07_simulation.rst diff --git a/doc/source/ch08_csst_common.rst b/docs/source/ch08_csst_common.rst similarity index 100% rename from doc/source/ch08_csst_common.rst rename to docs/source/ch08_csst_common.rst diff --git a/doc/source/ch09_build.rst b/docs/source/ch09_build.rst similarity index 100% rename from doc/source/ch09_build.rst rename to docs/source/ch09_build.rst diff --git a/doc/source/ch10_integration.rst b/docs/source/ch10_integration.rst similarity index 100% rename from doc/source/ch10_integration.rst rename to docs/source/ch10_integration.rst diff --git a/doc/source/ch11_data_products.rst b/docs/source/ch11_data_products.rst similarity index 100% rename from doc/source/ch11_data_products.rst rename to docs/source/ch11_data_products.rst diff --git a/doc/source/conf.py b/docs/source/conf.py similarity index 99% rename from doc/source/conf.py rename to docs/source/conf.py index 1db31103990c42246b5539c2c52b8ada8b52025c..b823a2d58ae6e4f41607c0784b42e9f28d7cc25d 100644 --- a/doc/source/conf.py +++ b/docs/source/conf.py @@ -12,7 +12,7 @@ # import os import sys -# . = /doc/source +# . = /docs/source # sys.path.insert(0, os.path.abspath('./csst_common/')) # sys.path.insert(0, os.path.abspath('../../')) sys.path.append(os.path.abspath('./csst_common/')) diff --git a/doc/source/csst_common/example_interface.py b/docs/source/csst_common/example_interface.py similarity index 100% rename from doc/source/csst_common/example_interface.py rename to docs/source/csst_common/example_interface.py diff --git a/doc/source/index.rst b/docs/source/index.rst similarity index 96% rename from doc/source/index.rst rename to docs/source/index.rst index 14ee00551536b1d19239a2e2a6ad1f86102d359e..3b50204c6b573c396125861f1d1939f8ff4e088c 100644 --- a/doc/source/index.rst +++ b/docs/source/index.rst @@ -57,6 +57,14 @@ The guide for LSST developers ---- +.. toctree:: + :hidden: + :maxdepth: 2 + :caption: C7 TASKS + + c7_changes.rst + + .. toctree:: :hidden: :maxdepth: 2 diff --git a/doc/source/preference/example_joblib.py b/docs/source/preference/example_joblib.py similarity index 100% rename from doc/source/preference/example_joblib.py rename to docs/source/preference/example_joblib.py diff --git a/doc/source/preference/example_multiprocessing.py b/docs/source/preference/example_multiprocessing.py similarity index 100% rename from doc/source/preference/example_multiprocessing.py rename to docs/source/preference/example_multiprocessing.py diff --git a/examples/how_this_code_will_be_used.py b/examples/how_this_code_will_be_used.py index b4e8f27418ba1da068de1a5115e96c4b107cd0c6..aa3647783ccf317e881400d5a87762420f5b9a42 100644 --- a/examples/how_this_code_will_be_used.py +++ b/examples/how_this_code_will_be_used.py @@ -3,7 +3,7 @@ from astropy.io import fits from csst.core.processor import CsstProcessor from csst.msc.data_manager import CsstMscDataManager -from csst_proto.top_level_interface import flip_image +from csst_proto.api import flip_image class CsstProcFlipImage(CsstProcessor): diff --git a/readthedocs.yml b/readthedocs.yml index 3d75d4c258022ef33b50aa9b96dc49da7eb68e1b..f8b6546cec3e8228f338771896d897beb1cf1720 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -14,7 +14,7 @@ build: # Build documentation in the docs/ directory with Sphinx sphinx: builder: html - configuration: doc/source/conf.py + configuration: docs/source/conf.py fail_on_warning: true # Optionally build your docs in additional formats such as PDF @@ -25,7 +25,7 @@ formats: # Optionally set the version of Python and requirements required to build your docs python: install: - - requirements: doc/requirements.txt + - requirements: docs/requirements.txt - method: pip path: . diff --git a/tests/test_demos.py b/tests/test_demos.py index c933f8fa8f83abf534a8acdcc4a697ba87b7a983..c39651d028a48849affa65f2794596fde20dbcdb 100644 --- a/tests/test_demos.py +++ b/tests/test_demos.py @@ -1,6 +1,6 @@ import unittest -from csst_proto.top_level_interface import a_demo_function +from csst_proto.api import a_demo_function class TestCaseDemoFunction(unittest.TestCase): diff --git a/tests/test_flip_image.py b/tests/test_flip_image.py index a76b4e0acafea10bc15bddf5c4d417fdc42c6d23..b2497bf3b5228ce4927d8636dc7403511ab41726 100644 --- a/tests/test_flip_image.py +++ b/tests/test_flip_image.py @@ -2,7 +2,7 @@ import unittest import numpy as np -from csst_proto.top_level_interface import flip_image, read_test_image +from csst_proto.api import flip_image, read_test_image from csst_proto.flip_image import flip_multiple_images_jl, flip_multiple_images_mp