======== 魟鱼
|主分支构建状态| |文档| |Slack| |joss| |doi| |主分支覆盖率状态| |GitHub 发布|
X射线光谱计时变得简单
Stingray 是一个用于天体物理X射线(和其他)数据的光谱计时软件包。
Stingray 整合了现有的 Python (光谱)计时包的开发工作,并遵循现代开源编程的最佳指南构建,效仿 Astropy
_ 的例子。
它提供:
- 一个时间序列方法库,包括功率谱、互谱、协方差谱、延迟等;
- 一组用于加载不同任务的 FITS 数据文件的脚本;
- 一个光变曲线和事件列表模拟器,能够模拟不同类型的变异性和基于给定物理事件(如回响)脉冲响应的更复杂现象。
有许多官方的X射线光谱拟合软件包(Xspec、ISIS、Sherpa等)。 然而,X射线计时方面还没有一个同等广泛使用的包:到目前为止,这通常是通过定制软件完成的。 Stingray 不仅旨在填补这一空白,还旨在提供文献中最先进的光谱计时技术的实现。 这个项目的最终目标是为社区提供一个软件包,在正确的统计框架下简化先进光谱计时技术的学习曲线。
当前和计划功能的更多细节可在 Stingray 文档 <https://docs.stingray.science/en/stable/#features>
_ 中找到。
安装和测试
Stingray 可以通过 conda
、pip
或直接从源代码库安装。
我们的文档提供了 全面的安装说明 <https://docs.stingray.science/en/stable/#installation>
_。
安装后,最好运行测试套件。
我们使用 py.test <https://pytest.org>
_ 和 tox <https://tox.readthedocs.io>
_ 进行测试,同样,我们的文档提供了 逐步说明 <https://docs.stingray.science/en/stable/#test-suite>
_。
文档
Stingray 的文档可以在 https://docs.stingray.science/ 找到。
联系我们,参与其中
我们欢迎贡献和反馈,我们需要你的帮助!
联系我们的最佳方式是通过 issues_
页面。
我们特别希望听到你的声音:
- 如果有什么出错了;
- 如果你发现缺少功能,觉得 API 不直观,或对未来开发有建议;
- 如果你有自己的代码实现了 Stingray 提供的任何方法,并产生了不同的结果。
更好的是:如果你有愿意贡献的代码,请发送 拉取请求
_ 或开启一个 issue
_。
相关软件包
HENDRICS <https://hendrics.stingray.science/>
_ 提供了一套命令行脚本,使用 Stingray 对 X 射线数据进行快速光谱计时分析。DAVE <https://github.com/StingraySoftware/dave>
_ 是建立在 Stingray 之上的图形用户界面。
引用 Stingray
如果你在研究中发现这个软件包有用,请适当地致谢和引用。
我们的文档 <https://docs.stingray.science/en/stable/citing.html>
_ 提供了进一步的指导,包括适当论文的链接和方便的 BibTeX 条目。
版权和许可
所有内容 © 2015 作者。
代码在 MIT 许可下分发;详情请参见 LICENSE.rst <LICENSE.rst>
_。