index.rst 1000 Bytes
Newer Older
BO ZHANG's avatar
BO ZHANG committed
1
csst
BO ZHANG's avatar
BO ZHANG committed
2
====
BO ZHANG's avatar
BO ZHANG committed
3
4
5
6
7
8
9

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

BO ZHANG's avatar
BO ZHANG committed
10
* Github: https://github.com/csster/csst
BO ZHANG's avatar
BO ZHANG committed
11
12
* PYPI: https://pypi.org/project/csst

BO ZHANG's avatar
BO ZHANG committed
13
Installation
BO ZHANG's avatar
BO ZHANG committed
14
------------
BO ZHANG's avatar
BO ZHANG committed
15
16

Install using `pip <https://pypi.org/project/matplotlib>`__:
BO ZHANG's avatar
BO ZHANG committed
17

BO ZHANG's avatar
BO ZHANG committed
18
19
20
   .. code-block:: bash

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

BO ZHANG's avatar
BO ZHANG committed
22
or
BO ZHANG's avatar
BO ZHANG committed
23

BO ZHANG's avatar
BO ZHANG committed
24
25
26
   .. code-block:: bash

       pip install -U csst
BO ZHANG's avatar
BO ZHANG committed
27

BO ZHANG's avatar
BO ZHANG committed
28
29
30
31
32
33
34
35
36
37
38

.. toctree::
   :hidden:
   :caption: DEVELOPMENT
   :maxdepth: 2

   csster
   fit_code
   contributors


BO ZHANG's avatar
BO ZHANG committed
39
.. toctree::
BO ZHANG's avatar
BO ZHANG committed
40
   :hidden:
BO ZHANG's avatar
BO ZHANG committed
41
   :caption: Examples
BO ZHANG's avatar
BO ZHANG committed
42
   :maxdepth: 2
BO ZHANG's avatar
BO ZHANG committed
43

BO ZHANG's avatar
BO ZHANG committed
44
   tutorial
BO ZHANG's avatar
BO ZHANG committed
45
46


BO ZHANG's avatar
BO ZHANG committed
47
.. toctree::
BO ZHANG's avatar
BO ZHANG committed
48
   :hidden:
BO ZHANG's avatar
BO ZHANG committed
49
50
51
   :maxdepth: 2
   :caption: API

BO ZHANG's avatar
BO ZHANG committed
52
   api/csst.core.rst
BO ZHANG's avatar
BO ZHANG committed
53
54
55
56
57
58
   api/csst.msc.rst


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


BO ZHANG's avatar
BO ZHANG committed
59
60
61
62
63
64
Indices and tables
==================

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