cpic v1.0 docs

source/cpic/cpism.rst

+CpicImgSim package
+==================
+
+Submodules
+----------
+
+CpicImgSim.main module
+----------------------
+
+.. automodule:: CpicImgSim.main
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+CpicImgSim.target module
+------------------------
+
+.. automodule:: CpicImgSim.target
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+CpicImgSim.optics module
+------------------------
+
+.. automodule:: CpicImgSim.optics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+CpicImgSim.camera module
+------------------------
+
+.. automodule:: CpicImgSim.camera
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+CpicImgSim.io module
+--------------------
+
+.. automodule:: CpicImgSim.io
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+CpicImgSim.config module
+------------------------
+
+.. automodule:: CpicImgSim.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+CpicImgSim.utils module
+-----------------------
+
+.. automodule:: CpicImgSim.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: CpicImgSim
+   :members:
+   :undoc-members:
+   :show-inheritance:

source/cpic/tutorials.rst

+使用教程
+===========
+
+仿真程序上手
+-------------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   快速开始 </notebooks/0_main_example.ipynb>
+
+程序模块使用说明
+----------------------
+.. toctree::
+   :maxdepth: 1
+
+   目标仿真模块 </notebooks/1_target_example.ipynb>
+   焦面模块 </notebooks/2_focus_example.ipynb>
+   观测效应仿真模块 </notebooks/3_obs_effect.ipynb>
+   相机仿真模块 </notebooks/4_camera_example.ipynb>
+   点扩散函数仿真模块 </notebooks/5_psf_example.ipynb>