Commit 8c841c48 authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

updated how-to-fit-code

parent 93826730
Loading
Loading
Loading
Loading
+19 −6
Original line number Diff line number Diff line
@@ -28,11 +28,24 @@ For each instrument, a specific data class should be constructed.
The pipeline
------------

A pipeline should have the structure like below.
A pipeline should have the structure like below. (see csst/)

.. code-block:: shell
.. code-block:: python

    from csst.core.processor import CsstProcessor

    class CsstProcDemo(CsstProcessor):
        def prepare(self, **args):
            # prepare the environment
            # for example, if you make use of some third-party software like SEXTRACTOR,
            # do your preparation here.
            pass

        def run(self, CsstData, *args, **kwargs):
            # run your pipeline here
            # make sure that your input data should be a child class instance of CsstData.
            pass

    CsstMscImgL0Proc
    ├── prepare()
    ├── run()
    └── cleanup()
        def cleanup(self, **kwargs):
            # clean up environment
            pass
+1 −1
Original line number Diff line number Diff line
@@ -33,7 +33,7 @@ How to contribute

.. toctree::
   :hidden:
   :caption: How-to contribute
   :caption: How to contribute
   :maxdepth: 2

   csster