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

updated how-to-fit-code

parent 93826730
...@@ -28,11 +28,24 @@ For each instrument, a specific data class should be constructed. ...@@ -28,11 +28,24 @@ For each instrument, a specific data class should be constructed.
The pipeline 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 def cleanup(self, **kwargs):
├── prepare() # clean up environment
├── run() pass
└── cleanup()
...@@ -33,7 +33,7 @@ How to contribute ...@@ -33,7 +33,7 @@ How to contribute
.. toctree:: .. toctree::
:hidden: :hidden:
:caption: How-to contribute :caption: How to contribute
:maxdepth: 2 :maxdepth: 2
csster csster
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment