installation.rst

CPISM程序安装说明
=================

Python版本
--------------
目前程序只在Python3.9下测试通过。建议尽量使用该版本运行。
如果使用anaconda，可选择使用conda创建虚拟环境后安装使用。


下载和安装
-----------------

下载和安装程序文件
```````````````````
使用以下命令，下载和安装程序文件

.. code-block:: bash 
    
    git clone https://csst-tb.bao.ac.cn/code/csst-sims/csst_cpic_sim.git
	cd csst_cpic_sim
	python setup.py install 

下载数据文件
```````````````````
通过科技云盘下载
链接地址：https://pan.cstcloud.cn/s/gjMlzXRuRsM	提取密码：i3Zs

运行测试
-----------------
程序安装测试
```````````````````

.. code-block:: bash

    python ./script/cpicsim.py --help
	
如果程序安装正确则会输出帮助信息。如果是首次运行，则会提示输入数据文件路径。
输入（复制粘贴）路径可进行配置。之后重新运行程序。

快速测试
```````````````````

.. code-block:: bash 

    python ./script/cpicsim.py quickrun '*0/15(0.4,0.6)' 10 50 6

如果运行成功，则可以在当前文件夹下看到生成的fits文件


程序配置
-----------------
可通过修改数据文件夹下的cpism_config.yaml文件进行仿真参数、输出参数等的配置。
cpic_config_default.yaml对可配置参数进行了示例。
这里建议只针对输入输出路径、星表文件夹等进行配置，而不更改例如望远镜尺寸、角分辨率等的配置。否则可能会产生不可预期的结果。


配置脚本并设置环境变量 (可选) 
--------------------
通过设计脚本并加入环境变量，可以极大的提高运行的舒适度。
cpicsim.ps1 和 cpicsim 分别是针对Windows 或 Linux/Mac 的脚本。
修改脚本中cpicsim.py的路径后，将script文件夹加入Path路径后，可以直接更简介的方法运行程序。
对于Linux/Mac用户，还需要使用chmod -x cpicsim设置可执行权限

.. code-block:: bash 
    
    cpicsim quickrun '*0/15(0.4,0.6)' 10 50 6