From 6fe3ad2e3971ed087a8a57c7a9398168863ebf2a Mon Sep 17 00:00:00 2001
From: Zhao Gang <gzhao@niaot.ac.cn>
Date: Fri, 19 Apr 2024 11:53:32 +0000
Subject: [PATCH] Upload New File

---
 source/cpic/installation.rst | 146 +++++++++++++++++++++++++++++++++++
 1 file changed, 146 insertions(+)
 create mode 100644 source/cpic/installation.rst

diff --git a/source/cpic/installation.rst b/source/cpic/installation.rst
new file mode 100644
index 0000000..511a63d
--- /dev/null
+++ b/source/cpic/installation.rst
@@ -0,0 +1,146 @@
+CPISM程序安装说明
+=================
+
+Python版本
+--------------
+
+Python >= 3.9
+
+使用setup.py安装
+-----------------
+
+联系作者获取软件安装文件，解压缩并执行以下命令：
+
+.. code-block:: bash 
+
+	cd cpic-img-sim
+	python setup.py install 
+
+设置环境变量 
+--------------
+
+Linux 或 Mac 用户
+```````````````````
+执行以下命令，打开bash配置文件：
+
+.. code-block:: bash
+
+	vi ~/.bash_profile
+
+在文件中增加如下一行：
+
+.. code-block:: bash
+
+	export cpism_refdata="/path/to/cpism/reference/"
+
+编辑bash profile文件后，需要source一下，或者重新打开一个terminal。
+
+.. code-block:: bash
+
+	source ~/.bash_profile
+
+可以用如下命令检查是否设置成功：
+
+.. code-block:: bash
+
+	echo $cpism_refdata
+	cd $cpism_refdata
+	ls
+
+Windows 用户
+`````````````
+执行以下操作：
+
+- 打开系统控制面板。
+- 选择“系统” 。
+- 选择“高级系统设置”。
+- 转到“ 高级 ”选项卡。
+- 选择 “环境变量...”。
+- 点击用户变量下的“新建...”。
+- 变量名为“cpism_refdata”，变量值为cpism_refdata文件夹的完整地址。
+- 连续点击“确定”，直到所以对话框都关闭。
+
+
+下载和安装 Pysynphot 恒星数据
+----------------------------------------
+
+CPISM中使用了 `Pysynphot package <https://pysynphot.readthedocs.io/en/latest/appendixa.html>`_ 来处理恒星光谱。为了得到恒星光谱，需要下载Pysynphot的恒星光谱数据。
+``CPISM`` 中使用了 Castelli-Kurucz 模型: `ck04models <https://archive.stsci.edu/hlsps/reference-atlases/cdbs/grid/ck04models/>`_. 
+
+可以使用如下命令进行安装
+
+.. code-block:: bash
+
+	wget http://ssb.stsci.edu/trds/tarfiles/synphot3.tar.gz
+
+下载完成后并解压，文件夹结果如下所示, 需要将trd文件夹加入到环境变量中。
+
+ ``<path>/grp/redcat/trds/grid/ck04models``
+
+Linux 或者 Mac 用户 
+````````````````````````````````
+
+.. code-block:: bash
+
+	vi ~/.bash_profile
+
+增加如下一行
+
+.. code-block:: bash
+
+	export PYSYN_CDBS="<your_path>/grp/redcat/trds"
+
+记得要source一下，或者重新打开一个terminal。 
+
+.. code-block:: bash
+
+	source ~/.bash_profile
+
+现在可以检查一下是否设置成功
+
+.. code-block:: bash
+
+	cd $PYSYN_CDBS
+	ls
+
+Windows 用户
+````````````````
+执行以下操作：
+
+- 打开系统控制面板。
+- 选择“系统” 。
+- 选择“高级系统设置”。
+- 转到“ 高级 ”选项卡。
+- 选择 “环境变量...”。
+- 点击用户变量下的“新建...”。
+- 变量名为“PYSYN_CDBS”，变量值为trds文件夹的完整地址。
+- 连续点击“确定”，直到所以对话框都关闭。
+
+程序运行配置
+------------------
+打开cpism_refdata文件夹，编辑cpism_config.yaml文件。可以进行cpism程序的运行配置。
+
+配置输出文件夹
+````````````````
+使用output_dir参数和relative_path参数配置初始文件夹的位置。
+
+- 当relative_path设置为True时，可以通过更改output_dir来更改输出文件夹的相对地址。例如，如果你想将输出文件夹放在cpism_refdata的父文件夹下的output目录中，你可以将output_dir设置为output。
+
+- 当relative_path设置为False时，可以通过设置output_dir来更改输出文件夹的绝对地址。
+
+其他配置
+````````````````
+- log_level: 日志的输出级别。可选择DEBUG、INFO、WARNING、ERROR、CRITICAL。日志文件存储在output文件夹的LOG目录下。
+- tmp_dir: 快速仿真结果的输出文件夹。默认为TMP，存储在output目录的TMP文件夹下。可选择current, 将文件存储于当前文件夹下。
+- check_fits_header: 输出文件时检查fits文件头的关键字是否和data model规定的一致，不一致时日志中输出warning信息。默认为False。
+
+
+测试是否安装成功
+------------------
+执行example.py 文件
+
+.. code-block:: bash
+
+	python example.py
+
+如果安装成功，会在output目录下SCI、CAL、TMP目录下分别生成科学观测图像文件、定标文件与快速模拟结果。文件结构详见星冕仪0级数据说明。
\ No newline at end of file
-- 
GitLab