update module headers

csst_common/__init__.py

@@ -3,17 +3,18 @@ Identifier:     csst_common/__init__.py
 Name:           __init__.py
 Description:    csst_common package
 Author:         Bo Zhang
-Created:        2022-09-13
+Created:        2022-09-21
 Modified-History:
-    2023-12-15, Bo Zhang, created
+    2022-09-21, Bo Zhang, created
+    2023-09-22, Bo Zhang, updates
     2023-12-15, Bo Zhang, add module header
 """
 
-from .status import CsstResult, CsstStatus
-from .pipeline import Pipeline
 from .ccds import CCDS
-from .dfs import DFS
 from .decorator import parameterized_module_decorator
+from .dfs import DFS
 from .file import File
+from .pipeline import Pipeline
+from .status import CsstResult, CsstStatus
 
 __version__ = "0.0.2"

csst_common/data_manager.py

@@ -30,11 +30,10 @@ from csst_dfs_api.facility.level1prc import Level1PrcApi
 from csst_dfs_api.mbi.level2 import Level2DataApi as MbiLevel2DataApi
 from csst_dfs_api.sls.level2spectra import Level2SpectraApi as SlsLevel2DataApi
 
+from .dfs import DFS
 from .logger import get_logger
 from .params import CSST_PARAMS as CP
 from .time import now
-from .ccds import CCDS
-from .dfs import DFS
 
 
 class CsstMsDataManager:

csst_common/decorator.py

@@ -3,9 +3,9 @@ Identifier:     csst_common/decorator.py
 Name:           decorator.py
 Description:    module wrapper
 Author:         Bo Zhang
-Created:        2022-09-13
+Created:        2023-12-10
 Modified-History:
-    2023-12-15, Bo Zhang, created
+    2023-12-10, Bo Zhang, rewrite ModuleResult and decorator
     2023-12-15, Bo Zhang, add module header
 """
 import functools

csst_common/dfs.py

 """
 Identifier:     csst_common/dfs.py
 Name:           dfs.py
-Description:    csst_common package
+Description:    DFS wrapper
 Author:         Bo Zhang
 Created:        2023-07-08
 Modified-History:

csst_common/file.py

 """
-Identifier:     csst_common/__init__.py
-Name:           __init__.py
-Description:    csst_common package
+Identifier:     csst_common/file.py
+Name:           file.py
+Description:    file operation
 Author:         Bo Zhang
 Created:        2023-12-13
 Modified-History:

csst_common/io.py

+"""
+Identifier:     csst_common/io.py
+Name:           io.py
+Description:    IO module
+Author:         Bo Zhang
+Created:        2023-12-13
+Modified-History:
+    2023-12-10, Bo Zhang, created
+    2023-12-15, Bo Zhang, add verify_checksum and append_header, add module header
+"""
 import warnings
 from copy import deepcopy
 

csst_common/logger.py

 """
-Identifier:     KSC-SJ4-csst_common/logger.py
+Identifier:     csst_common/logger.py
 Name:           logger.py
 Description:    CSST logger
 Author:         Bo Zhang
@@ -8,6 +8,7 @@ Modified-History:
     2022-10-04, Bo Zhang, created
     2022-10-04, Bo Zhang, added get_logger
     2022-10-07, Bo Zhang, added Numpydoc docstring
+    2023-12-10, Bo Zhang, add type annotation
 """
 import logging
 from typing import Optional

csst_common/params.py

 """
-Identifier:     KSC-SJ4-csst_common/params.py
+Identifier:     csst_common/params.py
 Name:           params.py
 Description:    CSST parameters
 Author:         Bo Zhang

csst_common/pipeline.py

+"""
+Identifier:     csst_common/pipeline.py
+Name:           file.py
+Description:    pipeline operation
+Author:         Bo Zhang
+Created:        2023-12-13
+Modified-History:
+    2023-07-11, Bo Zhang, created
+    2023-07-11, Bo Zhang, add Pipeline class
+    2023-12-10, Bo Zhang, update Pipeline
+    2023-12-15, Bo Zhang, add module header
+"""
 import json
 import os
 import subprocess
@@ -5,9 +17,10 @@ import warnings
 from typing import Any
 
 from astropy import time
-from .file import File
+
 from .ccds import CCDS
 from .dfs import DFS
+from .file import File
 from .logger import get_logger
 
 

csst_common/status.py

 """
-Identifier:     KSC-SJ4-csst_common/status.py
+Identifier:     csst_common/status.py
 Name:           status.py
 Description:    CSST status
 Author:         Bo Zhang

csst_common/utils/__init__.py

+"""
+Identifier:     csst_common/utils/__init__.py
+Name:           __init__.py
+Description:    CSST utils
+Author:         Bo Zhang
+Created:        2022-09-19
+Modified-History:
+    2022-09-19, Bo Zhang, created
+    2023-12-15, Bo Zhang, add module header
+"""
+
 from ._module_docstr import ModuleHeader
 from .tempfile import randfile

csst_common/utils/_module_docstr.py

 """
-Identifier:     KSC-SJ4-csst_common/utils.py
-Name:           utils.py
-Description:    This module collects a set of utilities for CSST L1 pipeline.
+Identifier:     csst_common/utils/_module_docstr.py
+Name:           _module_docstr.py
+Description:    module docstring
 Author:         Bo Zhang
 Created:        2022-09-06
 Modified-History:
     2022-09-06, Bo Zhang, Added header_str
-    2022-09-13, Bo Zhang, Added ModuleHeader class
+    2022-09-19, Bo Zhang, Added ModuleHeader class
+    2023-12-15, Bo Zhang, reformat module headers
 """
 import datetime
 import glob

csst_common/utils/tempfile.py

+"""
+Identifier:     csst_common/utils/__init__.py
+Name:           __init__.py
+Description:    CSST utils
+Author:         Bo Zhang
+Created:        2022-09-19
+Modified-History:
+    2022-09-19, Bo Zhang, created
+    2023-12-15, Bo Zhang, add module header
+"""
 
 import secrets
 import string