index.rst

.. 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
****

.. 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


************
Installation
************

Install using `pip <https://pypi.org/project/matplotlib>`__:
   .. code-block:: bash

       pip install -U git+git://github.com/csster/csst
or
   .. code-block:: bash

       pip install -U csst


.. toctree::
   :caption: Examples
   :maxdepth: 1

   tutorial


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

   api/csst.common.rst
   api/csst.msc.rst


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


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

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