index.rst 955 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
.. toctree::
BO ZHANG's avatar
BO ZHANG committed
29
   :caption: Examples
BO ZHANG's avatar
BO ZHANG committed
30
   :maxdepth: 1
BO ZHANG's avatar
BO ZHANG committed
31

BO ZHANG's avatar
BO ZHANG committed
32
   tutorial
BO ZHANG's avatar
BO ZHANG committed
33
   fit_code
BO ZHANG's avatar
BO ZHANG committed
34
35


BO ZHANG's avatar
BO ZHANG committed
36
37
38
39
.. toctree::
   :maxdepth: 2
   :caption: API

BO ZHANG's avatar
BO ZHANG committed
40
   api/csst.core.rst
BO ZHANG's avatar
BO ZHANG committed
41
42
43
   api/csst.msc.rst


BO ZHANG's avatar
BO ZHANG committed
44
45
46
47
48
49
50
51
52
The CSST team
-------------

Contributors to `csst` packages

* A
* B
* C

BO ZHANG's avatar
BO ZHANG committed
53
54
55
.. sectionauthor:: Bo Zhang <bozhang@nao.cas.cn>


BO ZHANG's avatar
BO ZHANG committed
56
57
58
59
60
61
Indices and tables
==================

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