index.rst

csst
====

.. meta::
   :description lang=cn: Automate building, versioning, and hosting of your technical documentation continuously on Read the Docs.


.. image:: https://readthedocs.org/projects/csst/badge/?version=latest
    :target: https://csst.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

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

* Github: https://github.com/csster/csst
* PYPI: https://pypi.org/project/csst


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

   .. code-block:: bash

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

or

   .. code-block:: bash

       pip install -U csst


How to contribute
-----------------

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

   csster
   fit_code
   contributors


Examples
--------

.. toctree::
   :hidden:
   :caption: Examples
   :maxdepth: 2

   tutorial


API
---

.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: API

   api/csst.core.rst
   api/csst.msc.rst


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


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`