updated doc

doc/source/team.rst → doc/source/ch01_team.rst

@@ -28,3 +28,15 @@ The timeline is splitted into cycles, and each cycle spans 6 months.
 - C6 (2022.7-2022.12)
     - integrate L1 pipelines
 - C5 (2022.1-2022.6)
+
+Weekly meeting
+--------------
+
+- 2022-08-26 (Fri)
+- 2022-09-02 (Fri)
+- 2022-09-09 (Fri)
+- 2022-09-16 (Fri)
+- 2022-09-23 (Fri)
+- 2022-09-30 (Fri)
+- 2022-10-14 (Fri)
+- 2022-10-21 (Fri)

doc/source/preference/preference.rst → doc/source/ch05_preference.rst

@@ -29,7 +29,7 @@ The two packages are preferred for implementing `embarrassingly` parallel comput
 - ``multiprocessing``: https://docs.python.org/3/library/multiprocessing.html
 - ``joblib``: https://joblib.readthedocs.io/en/latest/
 
-.. literalinclude:: ./example_multiprocessing.py
+.. literalinclude:: preference/example_multiprocessing.py
     :linenos:
     :language: python
     :caption: an example of using ``multiprocessing`` for parallel computing
@@ -40,7 +40,7 @@ The output is
 
     Total time cost: 5.095193147659302 sec!
 
-.. literalinclude:: ./example_joblib.py
+.. literalinclude:: preference/example_joblib.py
     :linenos:
     :language: python
     :caption: an example of using ``joblib`` for parallel computing

doc/source/csst_common/csst_common.rst → doc/source/ch08_csst_common.rst

@@ -16,14 +16,15 @@ A class that helps developers to access simulation files.
     from csst_common.data_manager import CsstMsDataManager
     # for full basic initialization
     dm_mbi = CsstMsDataManager(
-        ver_sim="C5.2",                 # version of simulation, "C5.2" is the latest
-        dir_l0="",                      # the L0/input directory
-        dir_l1="",                      # the L1/output directory
-        dir_pcref="",                   # position calibration reference (will be deprecated)
-        path_aux="",                    # aux file paths (master bias, dark, flat)
-        assert_all_detectors=False,     # if True, assert all detectors are available
-        datatype="mbi",                 # "mbi" or "sls"
+        ver_sim="C5.2",                  # version of simulation, "C5.2" is the latest
+        dir_l0="",                       # the L0/input directory
+        dir_l1="",                       # the L1/output directory
+        dir_pcref="",                    # position calibration reference (will be deprecated)
+        path_aux="",                     # aux file paths (master bias, dark, flat)
+        assert_all_detectors=False,      # if True, assert all detectors are available
+        datatype="mbi",                  # "mbi" or "sls"
     )
+    dm_mbi.set_detectors(detectors=None) # use all available detectors
 
 .. code-block:: python
 
@@ -32,8 +33,16 @@ A class that helps developers to access simulation files.
         ver_sim="C5.2",
         datatype="mbi",
         dir_l1=".",
-        exposure_id=100                 # the 100th exposure
+        exposure_id=100                  # the 100th exposure
     )
+    dm_mbi.set_detectors(detectors=None) # use all available detectors
+
+.. note::
+    This ``quickstart`` method is ONLY available on
+    ``dandelion`` and the Purple Mountain Lab node.
+    In your local development environment, you have to use
+    ``CsstMsDataManager(...)`` to initialize it.
+
 
 .. code-block:: python
 
@@ -179,7 +188,7 @@ The example code is shown below.
 Source code
 ^^^^^^^^^^^
 
-.. literalinclude:: example_interface.py
+.. literalinclude:: csst_common/example_interface.py
     :caption: ``example_interface.py``
     :emphasize-lines: 7-11,36-41,85,87-88,91-92,95-96,99-101,111-116,148,155-165,167-173,178-179,182-183,186-187,190-191
     :linenos:

doc/source/index.rst

@@ -62,7 +62,7 @@ The guide for LSST developers
    :maxdepth: 2
    :caption: TEAM
 
-   team.rst
+   ch01_team.rst
 
 
 .. toctree::
@@ -70,13 +70,13 @@ The guide for LSST developers
    :maxdepth: 2
    :caption: GUIDES FOR DEVELOPERS
 
-   vcs.rst
-   packaging.rst
-   codestyle.rst
-   preference/preference.rst
-   unittest.rst
-   simulation.rst
-   csst_common/csst_common.rst
+   ch02_vcs.rst
+   ch03_packaging.rst
+   ch04_codestyle.rst
+   ch05_preference.rst
+   ch06_unittest.rst
+   ch07_simulation.rst
+   ch08_csst_common.rst
 
 
 .. toctree::
@@ -84,8 +84,8 @@ The guide for LSST developers
    :maxdepth: 2
    :caption: CODE MANAGEMENT
 
-   build.rst
-   integration.rst
+   ch09_build.rst
+   ch10_integration.rst
 
 
 .. toctree::