From a24ec3553ff2cfd171d1d19af0df1b8320f7d35d Mon Sep 17 00:00:00 2001 From: BO ZHANG Date: Fri, 17 Mar 2023 13:49:32 +0800 Subject: [PATCH] update docstring for CsstMsDataManager --- csst_common/data_manager.py | 45 ++++++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 18 deletions(-) diff --git a/csst_common/data_manager.py b/csst_common/data_manager.py index d8d7f7c..cc40647 100644 --- a/csst_common/data_manager.py +++ b/csst_common/data_manager.py @@ -47,19 +47,24 @@ class CsstMsDataManager: To generate L0 and L1 file paths, use ``CsstMsDataManager.l0_detector()``, ``CsstMsDataManager.l1_detector()``, etc. Here are some examples for simulation with different versions. C3: - MSC_MS_210525220000_100000020_06_raw.fits - MSC_CRS_210525220000_100000020_06_raw.fits - MSC_210525120000_0000020_06.cat + * MSC_MS_210525220000_100000020_06_raw.fits + * MSC_CRS_210525220000_100000020_06_raw.fits + * MSC_210525120000_0000020_06.cat C5.1: - CSST_MSC_MS_SCI_20270810081950_20270810082220_100000100_06_L0_1.fits - CSST_MSC_MS_CRS_20270810081950_20270810082220_100000100_06_L0_1.fits - MSC_10000100_chip_06_filt_y.cat - MSC_10000100_chip_06_filt_y.log + * CSST_MSC_MS_SCI_20270810081950_20270810082220_100000100_06_L0_1.fits + * CSST_MSC_MS_CRS_20270810081950_20270810082220_100000100_06_L0_1.fits + * MSC_10000100_chip_06_filt_y.cat + * MSC_10000100_chip_06_filt_y.log C5.2 - CSST_MSC_MS_SCI_20270810081950_20270810082220_100000100_06_L0_1.fits - CSST_MSC_MS_CRS_20270810081950_20270810082220_100000100_06_L0_1.fits - MSC_100000100_chip_06_filt_y.cat - MSC_100000100_chip_06_filt_y.log + * CSST_MSC_MS_SCI_20270810081950_20270810082220_100000100_06_L0_1.fits + * CSST_MSC_MS_CRS_20270810081950_20270810082220_100000100_06_L0_1.fits + * MSC_100000100_chip_06_filt_y.cat + * MSC_100000100_chip_06_filt_y.log + C6.2 + * CSST_MSC_MS_SCI_20280716233448_20280716233718_10160000100_06_L0_V01.fits + * CSST_MSC_MS_CRS_20280716233448_20280716233718_10160000100_06_L0_V01.fits + * MSC_10160000100_chip_06_filt_y.cat + * MSC_10160000100_chip_06_filt_y.log Parameters ---------- @@ -86,12 +91,6 @@ class CsstMsDataManager: Use "pml" for Purple Mountain Lab cluster and "local" for others. dfs_root : str The DFS root path. - obs_id : str - The exposure ID. - exp_start : int - The exposure start time in ``yyyymmddhhmmss`` format. - exp_stop : int - The exposure start time in ``yyyymmddhhmmss`` format. telescope : str The telescope name. Defaults to ``CSST`` for C5.2 simulation. instrument : str @@ -100,8 +99,18 @@ class CsstMsDataManager: The survey name. Defaults to ``MS`` for C5.2 simulation. obs_type : str The image type signature for science images. Defualts to ``SCI`` for C5.2 simulation. + exp_start : int + The exposure start time in ``yyyymmddhhmmss`` format. + exp_stop : int + The exposure start time in ``yyyymmddhhmmss`` format. + obs_id : str + The exposure ID. level : str - The postfix. Defaults to ``L0_1`` for C5.2 simulation. + The data level, i.e., ``0``. + version : str + The L0 version. + ext : str + The extension name, i.e., ``.fits``. log_ppl : str The pipeline log file name. log_mod : str -- GitLab