Welcome to CSST Emulator's documentation!
=========================================

.. image:: ./pic/csstemulator-green.png
      :alt: CSST Emulator
      :height: 50 px


**CSST Emulator** is a cosmological emulator for China Space Station Telescope (**CSST**) optical survey.
This is a pure Python package that provides a simple and intuitive API for predicting the commonly used statistics, 
e.g., matter power spectrum.
We use the `Kun (鲲, in Chinese) Suite <https://kunsimulation.readthedocs.io/en/latest/>`_ as the training data, which includes **129** high-resolution N-body simulations, which are generated by 
the modified version of the `Gadget-4` code with **129** different cosmologies.
So it can achieve a high accuracy in a wide range of cosmological parameters as followed.

.. _cosmology-table:

Cosmology Space
===============

+-------------------------------+-------------+-------------+
| Parameter                     | Lower Limit | Upper Limit |
+===============================+=============+=============+
| :math:`\Omega_b`              | 0.04        | 0.06        |
+-------------------------------+-------------+-------------+
| :math:`\Omega_{cb}`           | 0.24        | 0.40        |
+-------------------------------+-------------+-------------+
| :math:`H_0`                   | 60          | 80          |
+-------------------------------+-------------+-------------+
| :math:`n_s`                   | 0.92        | 1.00        |
+-------------------------------+-------------+-------------+
| :math:`A_s\times 10^{9}`      | 1.7         | 2.5         |
+-------------------------------+-------------+-------------+
| :math:`w`                     | -1.3        | -0.7        |
+-------------------------------+-------------+-------------+
| :math:`w_a`                   | -0.5        | 0.5         |
+-------------------------------+-------------+-------------+
| :math:`\sum M_{\nu}`          | 0           | 0.3         |
+-------------------------------+-------------+-------------+

The detailed cosmologies can be found in the :doc:`cosmologies` section.
Check out the :doc:`pkmm` section for further guides, including
how to :doc:`install` the project.

.. note::

   This project is under **active** development. 
   You can visit the `GitHub repository <https://github.com/czymh/csstemu/tree/dev>`__ for the latest updates.

Contents
========

.. toctree::
   :maxdepth: 2
   :caption: Emulator

   install 
   pklin
   pkmm
   hmf
   ximm
   xihm
   api
   
.. toctree::
   :maxdepth: 2
   :caption: Data

   cosmologies
   visualization

Acknowledgement
===============

Feel free to contact <chyiru@sjtu.edu.cn> or leave an issue on the GitHub if you have any questions.