index.rst 967 Bytes
Newer Older
BO ZHANG's avatar
BO ZHANG committed
1
2
3
4
5
.. 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.

BO ZHANG's avatar
BO ZHANG committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
****
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).

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

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

   .. code-block:: bash

       pip install -U git+git://github.com/csster/csst
BO ZHANG's avatar
BO ZHANG committed
25

BO ZHANG's avatar
BO ZHANG committed
26
27

.. toctree::
BO ZHANG's avatar
BO ZHANG committed
28
   :caption: Examples
BO ZHANG's avatar
BO ZHANG committed
29
   :maxdepth: 1
BO ZHANG's avatar
BO ZHANG committed
30

BO ZHANG's avatar
BO ZHANG committed
31
   tutorial
BO ZHANG's avatar
BO ZHANG committed
32
33


BO ZHANG's avatar
BO ZHANG committed
34
35
36
37
38
39
40
41
42
43
44
.. toctree::
   :maxdepth: 2
   :caption: API

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


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


BO ZHANG's avatar
BO ZHANG committed
45
46
47
48
49
50
Indices and tables
==================

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