Commit bb09788b authored by yuedong0607's avatar yuedong0607
Browse files

and English readme, move the updates to CHANGELOG.md files

parent 94c65fe8

CHANGELOG.en.md

0 → 100644
+48 −0
Original line number Diff line number Diff line 
[English](CHANGELOG.en.md) | [中文](CHANGELOG.md)

* 2025.07.10: Updated to version v3.3 for the 1000 square degree wide survey and 50 square degree deep survey simulations. Changes include:

    * Updated several detector parameters based on the latest measurements

    * Added slitless spectroscopy PSF and LED image generation tools

    * Updated spectroscopy dispersion files

    * Updated system throughput curves

    * Updated FITS header keywords

    * Added the `data_set` keyword in the config file



* 2025.05.21: Updated to version v3.2. Changes include:

    * Added bright-star PSF extrapolation module

    * Added crosstalk simulation module

    * Memory optimization for simulations

    * Updated FITS header keywords

    * Added charge diffusion in the slitless spectroscopy PSF model

    * Updated PEP8 formatting conventions

    * Bug fixes: truncated magnitude calculation, deep field calculation, slitless spectroscopy PSF, saturation overflow, and truncation issues in channel trailing caused by bad columns



* 2024.08.03: Updated to version v3.1. Changes include:

    * Added simulation of the guide-star stabilization process

    * Added Milky Way extinction simulation

    * Bug fixes: fixed issues such as inconsistent simulated magnitudes caused by filter light leakage



* 2024.05.15: Updated to version v3.0. See the [Software Documentation](https://kdocs.cn/l/cjyiU0SXGyn2) for details of the new features.



* 2023.07.29: Updated to version v2.1. Changes include:

    * Added stray-light simulation module with config switch: `enable_straylight_model: True/False`

    * Updated WCS definition: `x: E`, `y: -N`

    * Updated FITS header keywords

    * Adapted to the C6 50-square-degree simulation catalogs

    * Bug fixes: fixed incorrect distortion directions caused by field distortion and related issues



* 2023.05.01: Updated to version v2.0. New features include:

    * C6 simulation support

    * FITS image overlay functionality

    * Individually configurable focal-plane detector properties

    * One-degree rotation for slitless spectroscopy detectors

    * Simulation of source distortion caused by field distortion

    * Guide-star detector simulation

    * Updated instrument parameters and bug fixes



* 2022.08.23: Updated to the latest throughput curves and added version information to FITS image headers. Simulation software version numbering was reset; current version is v1.0.4.



* 2022.06.20: Version v0.5 released on the `release_v0.5` branch (Note: version numbering has since been reset to v1.0; current branch is `release_v1.0.0`)



* 2022.04.13: Fixed a calling error in the astrometry module



* 2022.04.08: Fixed issues related to the catalog-only output option (`out_cat_only`)
 
 No newline at end of file

CHANGELOG.md

0 → 100644
+48 −0
Original line number Diff line number Diff line 
[English](CHANGELOG.en.md) | [中文](CHANGELOG.md)

* 2025.07.10: 针对1000平方度宽场及50平方度深场仿真，更新至v3.3版本，内容包括：

    * 根据最新实测结果，更新部分探测器参数

    * 加入光谱PSF、LED图像获取工具

    * 更新光谱分光文件

    * 更新系统效率曲线

    * 更新头文件关键字

    * 在config中加入data_set关键字



* 2025.05.21: 更新至v3.2版本，内容包括：

    * 加入亮星PSF外插模块

    * 加入串扰模块

    * 仿真内存优化

    * 头文件关键字更新

    * 在无缝光谱PSF模型中添加电子弥散

    * 更新PEP8格式规范

    * BUG修复：截断星等计算、深场计算、无缝光谱PSF、饱和溢出和坏像列在通道间的拖尾截断等



* 2024.08.03: 更新至v3.1版本，内容包括：

    * 加入对导星稳像过程的仿真

    * 加入银河系消光的仿真

    * Bug修复：修复因滤光片漏光导致的仿真星等不吻合等bug



* 2024.05.15: 更新至v3.0版本，新功能具体内容见[软件说明文档](https://kdocs.cn/l/cjyiU0SXGyn2)。



* 2023.07.29: 更新至v2.1版本，内容包括：

    * 加入杂散光模块，config文件中添加开关：enable_straylight_model: True/False

    * 调整WCS定义：x：E, y：-N

    * 头文件关键字调整

    * 适配C6-50平方度仿真星表

    * Bug修复：修复像场畸变导致形变的方向错误等bug



* 2023.05.01: 更新至v2.0版本，新功能包含：

    * C6仿真实现

    * fits贴图功能

    * 焦面探测器属性单独定义

    * 无缝光谱探测器一度旋转

    * 像场畸导致目标形变的仿真

    * 导星探测器仿真

    * 仪器参数更新，bug修复等



* 2022.08.23: 更新至最新的透过率曲线，在图像头文件中加入版本号。仿真软件版本号进行重新标记，当前版本为1.0.4



* 2022.06.20: 版本v0.5上线，release_v0.5 branch(注：目前已重新设置为v1.0，release_v1.0.0)



* 2022.04.13: 修复了天测模块中的调用错误



* 2022.04.08: 修复了仅输出星表选项("out_cat_only")存在的问题
 
 No newline at end of file

README.en.md

0 → 100644
+160 −0
Original line number Diff line number Diff line 
[English](README.en.md) | [中文](README.md)

# CSST Main Survey Simulation Software



<!-- ## 重要更新或问题修复：

* 2025.07.10: 针对1000平方度宽场及50平方度深场仿真，更新至v3.3版本，内容包括：

    * 根据最新实测结果，更新部分探测器参数

    * 加入光谱PSF、LED图像获取工具

    * 更新光谱分光文件

    * 更新系统效率曲线

    * 更新头文件关键字

    * 在config中加入data_set关键字

* 2025.05.21: 更新至v3.2版本，内容包括：

    * 加入亮星PSF外插模块

    * 加入串扰模块

    * 仿真内存优化

    * 头文件关键字更新

    * 在无缝光谱PSF模型中添加电子弥散

    * 更新PEP8格式规范

    * BUG修复：截断星等计算、深场计算、无缝光谱PSF、饱和溢出和坏像列在通道间的拖尾截断等

* 2024.08.03: 更新至v3.1版本，内容包括：

    * 加入对导星稳像过程的仿真

    * 加入银河系消光的仿真

    * Bug修复：修复因滤光片漏光导致的仿真星等不吻合等bug

* 2024.05.15: 更新至v3.0版本，新功能具体内容见[软件说明文档](https://kdocs.cn/l/cjyiU0SXGyn2)。

* 2023.07.29: 更新至v2.1版本，内容包括：

    * 加入杂散光模块，config文件中添加开关：enable_straylight_model: True/False

    * 调整WCS定义：x：E, y：-N

    * 头文件关键字调整

    * 适配C6-50平方度仿真星表

    * Bug修复：修复像场畸变导致形变的方向错误等bug

* 2023.05.01: 更新至v2.0版本，新功能包含：

    * C6仿真实现

    * fits贴图功能

    * 焦面探测器属性单独定义

    * 无缝光谱探测器一度旋转

    * 像场畸导致目标形变的仿真

    * 导星探测器仿真

    * 仪器参数更新，bug修复等

* 2022.08.23: 更新至最新的透过率曲线，在图像头文件中加入版本号。仿真软件版本号进行重新标记，当前版本为1.0.4

* 2022.06.20: 版本v0.5上线，release_v0.5 branch(注：目前已重新设置为v1.0，release_v1.0.0)

* 2022.04.13: 修复了天测模块中的调用错误

* 2022.04.08: 修复了仅输出星表选项("out_cat_only")存在的问题 -->



<!-- ## 使用方法及相关说明 -->



<!-- * 软件安装和使用方法可参考：[软件说明文档](https://kdocs.cn/l/cjyiU0SXGyn2)(持续更新中)。 -->

<!---

* 仿真数据说明文档：[C6数据说明文档](https://www.kdocs.cn/l/cuRmPf71Ly7v)

* 在线版使用说明：[CSST网页接口使用说明](https://kdocs.cn/l/cl81flAXe1YQ)

-->

<!-- * 问题反馈请使用Issues，若无国台gitlab账号，请使用:[问题反馈表](https://f.kdocs.cn/w/XYcBkE63/) -->



## Usage and Documentation



* Installation and usage instructions are available in the [Software Documentation](https://kdocs.cn/l/cjyiU0SXGyn2) (continuously updated).



<!---

* Simulation data documentation: [C6 Data Documentation](https://www.kdocs.cn/l/cuRmPf71Ly7v)

* Online interface instructions: [CSST Web Interface User Guide](https://kdocs.cn/l/cl81flAXe1YQ)

-->



* Please use GitLab Issues for bug reports and feedback. If you do not have a NAOC GitLab account, please use the [Feedback Form](https://f.kdocs.cn/w/XYcBkE63/).



<!-- ## 仿真数据产品说明



* Cycle 9 仿真数据产品：[CSST主巡天Cycle9数据产品说明](https://pan.cstcloud.cn/s/gHVB8p2TDA)

* 往期已发布数据产品说明：[CSST主巡天往期仿真数据产品说明](https://pan.cstcloud.cn/s/zRF7mu3ET5c) -->



## Simulation Data Products



* Cycle 9 simulation data products: [CSST Main Survey Cycle 9 Data Product Description](https://pan.cstcloud.cn/s/gHVB8p2TDA)



* Previously released simulation data products: [CSST Main Survey Historical Simulation Data Products](https://pan.cstcloud.cn/s/zRF7mu3ET5c)



<!-- ## 相关输入数据 -->



<!-- * PSF采样数据下载：[百度云盘](https://pan.baidu.com/s/1_2gbO6-d7x001_FMqZ1tfw)，提取码：2awt



* 测试用数据，C6星系SED PCA主成分，及恒星SED模板库下载：[百度云盘](https://pan.baidu.com/s/15B5H-r39vbIBIXdpin63Wg)，提取码：nxsy



* 滤光片及无缝光谱相关数据：[百度云盘](https://pan.baidu.com/s/1JROggg8IKf27i1DnwTaPAw)，提取码：07v5 -->

<!-- * 数据链接：https://pan.baidu.com/s/1cVHovDs4cMsDWWNkoZDRDA?pwd=y63x

    * PSF数据库：

        * 多色成像: CSSTSim_C9/PSFCube/set1_dynamic 

        * 无缝光谱: CSSTSim_C9/PSFCube/SLS_PSF_PCA_fp

    * C9星表数据：

        * 恒星星表：CSSTSim_C9/starcat_C9

        * 星系星表：CSSTSim_C9/galaxycat_C9/cat2CSSTSim_bundle-50sqDeg

        * 类星体星表：CSSTSim_C9/galaxycat_C9/qsosed -->



## Related Input Data



* Data link: https://pan.baidu.com/s/1cVHovDs4cMsDWWNkoZDRDA?pwd=y63x



    * PSF data:

        * Multiband imaging:

          `CSSTSim_C9/PSFCube/set1_dynamic`

        * Slitless spectroscopy:

          `CSSTSim_C9/PSFCube/SLS_PSF_PCA_fp`



    * C9 catalog data:

        * Stellar catalogs:

          `CSSTSim_C9/starcat_C9`

        * Galaxy catalogs:

          `CSSTSim_C9/galaxycat_C9/cat2CSSTSim_bundle-50sqDeg`

        * Quasar catalogs:

          `CSSTSim_C9/galaxycat_C9/qsosed`



<!-- ## 引用说明

> **注意**：本项目的软件及相关数据产品**仅供科研与学术交流使用**。



如果您在研究工作中使用了本项目的软件或相关数据，请引用相关论文，并在论文或报告中注明本项目。



|      | 论文标题 | DOI 链接 |

| :--- | :--- | :--- |

| **仿真软件及数据** | Mock Observations for the CSST Mission: Main Surveys─An Overview of Framework and Simulation Suite | [10.1088/1674-4527/ae20fe](https://doi.org/10.1088/1674-4527/ae20fe) |

| **仿真软件-无缝光谱** | Mock Observations for the CSST Mission: Main Surveys—The Slitless Spectroscopy Simulation | [10.1088/1674-4527/ae20fa](https://doi.org/10.1088/1674-4527/ae20fa) |

| **仿真软件-星系星表** | Mock Observations for the CSST Mission: Main Surveys─The Mock Catalog | [10.1088/1674-4527/ae20ff](https://doi.org/10.1088/1674-4527/ae20ff) |

| **点扩散函数数据** | Mock Observations for the CSST Mission: End-to-end Performance Modeling of Optical System | [10.1088/1674-4527/ae20fb](https://doi.org/10.1088/1674-4527/ae20fb) |



---

感谢对本项目工作的支持与认可。 -->



## Citation



> **Note:** The software and related data products in this project are intended **for scientific research and academic exchange only**.



If you use this software or related datasets in your research, please cite the corresponding papers and acknowledge this project in your publication or report.



| Category | Paper Title | DOI |

| :--- | :--- | :--- |

| **Simulation Software and Data** | Mock Observations for the CSST Mission: Main Surveys─An Overview of Framework and Simulation Suite | [10.1088/1674-4527/ae20fe](https://doi.org/10.1088/1674-4527/ae20fe) |

| **Simulation Software – Slitless Spectroscopy** | Mock Observations for the CSST Mission: Main Surveys—The Slitless Spectroscopy Simulation | [10.1088/1674-4527/ae20fa](https://doi.org/10.1088/1674-4527/ae20fa) |

| **Simulation Software – Galaxy Catalogs** | Mock Observations for the CSST Mission: Main Surveys─The Mock Catalog | [10.1088/1674-4527/ae20ff](https://doi.org/10.1088/1674-4527/ae20ff) |

| **Point Spread Function Data** | Mock Observations for the CSST Mission: End-to-end Performance Modeling of Optical System | [10.1088/1674-4527/ae20fb](https://doi.org/10.1088/1674-4527/ae20fb) |



---



Thank you for your support and recognition of this project.





<!-- ## 相关会议及workshop



* 2023年5月8日，福建泉州，CSST科学数据处理系统与科学团队讨论会：[会议视频](https://pan.baidu.com/s/1VH8rg6jC09ZsVlMmO2zhbQ)，视频提取码：7hsu



* 2022年4月6日，国家天文台，软件发布及使用MiniWorkShop相关信息：[20220406](https://www.kdocs.cn/l/cnovDlrgyDlu)，[会议视频](https://pan.baidu.com/s/1eCtLTi3EZ8f6KQGvmqjp_Q?pwd=ow9q)，视频提取码：ow9q -->



## Related Meetings and Workshops



* May 8, 2023, Quanzhou, Fujian —  CSST Scientific Data Processing System and Science Team Workshop: [Workshop Video](https://pan.baidu.com/s/1VH8rg6jC09ZsVlMmO2zhbQ), Video extraction code: `7hsu`



* April 6, 2022, National Astronomical Observatories — Software Release and Mini Workshop Information: [20220406](https://www.kdocs.cn/l/cnovDlrgyDlu), [Workshop Video](https://pan.baidu.com/s/1eCtLTi3EZ8f6KQGvmqjp_Q?pwd=ow9q), Video extraction code: `ow9q`



<!-- ## 开发须知



* 本Gitlab仓库相关开发流程：[CSST主巡天仿真Gitlab工作流程](https://kdocs.cn/l/cnvJY7RkzwW9) -->



## Development Notes



* Development workflow for this GitLab repository: [CSST Main Survey Simulation GitLab Workflow](https://kdocs.cn/l/cnvJY7RkzwW9)

README.md

+3 −2
Original line number Diff line number Diff line 
[English](README.en.md) | [中文](README.md)

# CSST主巡天仿真软件



## 重要更新或问题修复：

<!-- ## 重要更新或问题修复：

* 2025.07.10: 针对1000平方度宽场及50平方度深场仿真，更新至v3.3版本，内容包括：

    * 根据最新实测结果，更新部分探测器参数

    * 加入光谱PSF、LED图像获取工具
@@ -38,7 +39,7 @@ 
* 2022.08.23: 更新至最新的透过率曲线，在图像头文件中加入版本号。仿真软件版本号进行重新标记，当前版本为1.0.4

* 2022.06.20: 版本v0.5上线，release_v0.5 branch(注：目前已重新设置为v1.0，release_v1.0.0)

* 2022.04.13: 修复了天测模块中的调用错误

* 2022.04.08: 修复了仅输出星表选项("out_cat_only")存在的问题

* 2022.04.08: 修复了仅输出星表选项("out_cat_only")存在的问题 -->



## 使用方法及相关说明