Commit 2c14e4c3 authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

added fit_code

parent 1ccdfc65

doc/source/api/csst.common.rst→doc/source/api/csst.core.rst

+9 −9
Original line number Original line Diff line number Diff line 
csst.common

csst.core

===========

=========





csst.common.data

csst.core.data

----------------

--------------





.. automodule:: csst.common.data

.. automodule:: csst.core.data

   :members:

   :members:

   :undoc-members:

   :undoc-members:

   :show-inheritance:

   :show-inheritance:





csst.common.exception

csst.core.exception

---------------------

---------------------





.. automodule:: csst.common.exception

.. automodule:: csst.core.exception

   :members:

   :members:

   :undoc-members:

   :undoc-members:

   :show-inheritance:

   :show-inheritance:





csst.common.processors

csst.core.processors

----------------------

----------------------





.. automodule:: csst.common.processors

.. automodule:: csst.core.processor

   :members:

   :members:

   :undoc-members:

   :undoc-members:

   :show-inheritance:
 
   :show-inheritance:

doc/source/conf.py

+1 −1
Original line number Original line Diff line number Diff line 
# Configuration file for the Sphinx documentation builder.

# Configuration file for the Sphinx documentation builder.

#

#

# This file only contains a selection of the most common options. For a full

# This file only contains a selection of the most core options. For a full

# list see the documentation:

# list see the documentation:

# https://www.sphinx-doc.org/en/master/usage/configuration.html

# https://www.sphinx-doc.org/en/master/usage/configuration.html

doc/source/fit_code.rst

0 → 100644
+38 −0
Original line number Original line Diff line number Diff line 
Fit your code to this project

=============================

Take the main survey (MSC) as an example.

A demo structure is shown below.



.. code-block:: shell



    msc

    ├── __init__.py

    ├── data.py

    │   └── CsstMscImgData class

    └── processor.py

        └── CsstMscImgL0Proc class





The data class

--------------



For each instrument, a specific data class should be constructed.

`CsstData` class is the root class.



.. code-block:: shell



    CsstData

    └── CsstMscData

        └── CsstMscImgData



The pipeline

------------



A pipeline should have the structure like below.



.. code-block:: shell



    CsstMscImgL0Proc

    ├── prepare()

    ├── run()

    └── cleanup()

doc/source/index.rst

+17 −13
Original line number Original line Diff line number Diff line 
.. csst documentation master file, created by

   sphinx-quickstart on Tue Mar  1 14:45:29 2022.

   You can adapt this file completely to your liking, but it should at least

   contain the root `toctree` directive.



****

csst

csst

****

====





.. image:: https://readthedocs.org/projects/csst/badge/?version=latest

.. image:: https://readthedocs.org/projects/csst/badge/?version=latest

    :target: https://csst.readthedocs.io/en/latest/?badge=latest

    :target: https://csst.readthedocs.io/en/latest/?badge=latest
@@ -13,39 +7,49 @@ csst 




`csst` is the pipeline package for the **CSST** (Chinese Space Station Telescope).

`csst` is the pipeline package for the **CSST** (Chinese Space Station Telescope).





* github: https://github.com/csster/csst

* Github: https://github.com/csster/csst

* PYPI: https://pypi.org/project/csst

* PYPI: https://pypi.org/project/csst







************

Installation

Installation

************

------------





Install using `pip <https://pypi.org/project/matplotlib>`__:

Install using `pip <https://pypi.org/project/matplotlib>`__:



   .. code-block:: bash

   .. code-block:: bash





       pip install -U git+git://github.com/csster/csst

       pip install -U git+git://github.com/csster/csst



or

or



   .. code-block:: bash

   .. code-block:: bash





       pip install -U csst

       pip install -U csst







.. toctree::

.. toctree::

   :caption: Examples

   :caption: Examples

   :maxdepth: 1

   :maxdepth: 1





   tutorial

   tutorial

   fit_code









.. toctree::

.. toctree::

   :maxdepth: 2

   :maxdepth: 2

   :caption: API

   :caption: API





   api/csst.common.rst

   api/csst.core.rst

   api/csst.msc.rst

   api/csst.msc.rst









The CSST team

-------------



Contributors to `csst` packages



* A

* B

* C



.. sectionauthor:: Bo Zhang <bozhang@nao.cas.cn>

.. sectionauthor:: Bo Zhang <bozhang@nao.cas.cn>