initial commit

README.md

+## CSST 
+[![Documentation Status](https://readthedocs.org/projects/csst/badge/?version=latest)](https://csst.readthedocs.io/en/latest/?badge=latest)
+ 
+CSST pipeline prototype.
+
+## Homepage
+
+- Gitlab: https://csst-tb.bao.ac.cn/code/hypergravity/csst_proto
+
+
+## Install
+```
+git clone https://csst-tb.bao.ac.cn/code/hypergravity/csst_proto.git
+cd csst_proto
+sh install.sh
+```
+

csst_proto/__init__.py

+__version__ = "0.0.1"

demo/demo_docstring.py

+import numpy as np
+
+
+# this function need to be finished
+def cos_to_be_finished(x):
+    # TODO: to be finished
+    return
+
+
+# a function with a simple docstring
+def _cos(x):
+    """ this is a cosine function """
+    return np.cos(x)
+
+
+# a function with a complete docstring
+def cos(x: float = 0.):
+    """ cosine function
+
+    Parameters
+    ----------
+    x :
+        x values
+
+    Returns
+    -------
+    cos(x)
+
+    """
+    return np.cos(x)
+
+

demo/demo_processor.py

+import joblib
+
+from csst.core.processor import CsstProcessor
+from csst.msc.data_manager import CsstMscDataManager
+
+
+class CsstProcPhotonAbsorption(CsstProcessor):
+    """ This processor absorbs photons """
+
+    def __init__(self, dm: CsstMscDataManager, n_jobs: int = 1):
+        super(CsstProcPhotonAbsorption, self).__init__()
+        self.dm = dm
+        self.n_jobs = n_jobs
+
+    def run(self, debug=False):
+        """ run this processor
+
+        Parameters
+        ----------
+        debug
+            if True, use debug mode
+
+        Returns
+        -------
+
+        """
+        joblib.Parallel(n_jobs=self.n_jobs)(
+            joblib.delayed(CsstProcPhotonAbsorption.run_one_chip)(this_ccd_id)
+            for this_ccd_id in self.dm.target_ccd_ids)
+        return
+
+    def prepare(self, **kwargs):
+        """ prepare the environment """
+        return
+
+    def cleanup(self):
+        """ clean up the environment """
+        return
+
+    @staticmethod
+    def run_one_chip(ccd_id):
+        """ run for one chip """
+        return

setup.py

+import setuptools
+import csst_proto
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name='csst',
+    version=csst_proto.__version__,
+    author='CSST Team',
+    author_email='bozhang@nao.cas.cn',
+    description='The CSST pipeline',  # short description
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url='https://csst.readthedocs.io',
+    project_urls={
+        'Source': 'http://github.com/csster/csst',
+    },
+    packages=setuptools.find_packages(),
+    license='MIT',
+    classifiers=["Development Status :: 5 - Production/Stable",
+                 "Intended Audience :: Science/Research",
+                 "License :: OSI Approved :: MIT License",
+                 "Operating System :: OS Independent",
+                 "Programming Language :: Python :: 3.7",
+                 "Topic :: Scientific/Engineering :: Physics",
+                 "Topic :: Scientific/Engineering :: Astronomy"],
+    package_dir={'csst': 'csst'},
+    # include_package_data=True,
+    package_data={"": ["LICENSE", "README.md"],
+                  "csst_proto": ["data/your_data.txt",
+                                 ]},
+    # install_requires=['sphinx',
+    #                   'numpy',
+    #                   'scipy', 'matplotlib',
+    #                   'astropy', 'healpy', 'ccdproc', 'deepCR', 'photutils'],
+    python_requires='>=3.7',
+)