跳转到主要内容

计算射电望远镜对宇宙21厘米信号的灵敏度。

项目描述

PyPI - Version https://codecov.io/gh/rasg-affiliates/21cmSense/branch/main/graph/badge.svg https://img.shields.io/badge/code%20style-black-000000.svg Documentation Status https://img.shields.io/github/license/Ileriayo/markdown-badges?style=flat https://joss.theoj.org/papers/10.21105/joss.06501/status.svg

一个Python包,用于计算21厘米实验对再电离时代和/或宇宙黎明功率谱的预期灵敏度。

安装

对于用户

克隆/下载该包,并在顶级目录中运行 pip install [-e] .

如果您是 conda 用户(我们推荐这样做),您可能希望使用 conda 而不是使用 pip 自动安装以下内容

$ conda install numpy scipy pyyaml astropy

为了测试包是否正确安装,使用 pip install -e .[test] 安装,并在顶级目录中运行 pytest

对于开发

克隆/下载该包,并在顶级目录中运行 pip install [-e] .[dev]

运行 pre-commit install; pre-commit install --hook-type=commit-msg 以安装pre-commit钩子检查。

我们建议使用 commitizen 工具编写提交信息 - 我们使用提交信息进行版本控制!

有关如何为项目做出贡献的更多信息,请参阅 贡献文档

用法

使用此代码有两种方式:作为Python库或通过CLI。有关使用库的更多文档,请参阅文档,特别是入门教程。有关CLI的更详细介绍,请参阅CLI教程

作为一个例子,最简单的使用方法是通过CLI如下所示

$ sense calc-sense <SENSITIVITY_CONFIG_FILE.yml>

可以通过以下方式读取程序calc-sense的其他选项

$ sense calc-sense --help

示例配置文件位于此存储库中的example_configs/sensitivity_hera.yml,其中详细说明了可以设置的各个参数。总共需要三个配置文件 - 一个定义天文台,另一个定义观测,以及之前提到的灵敏度配置文件。

CLI也可以通过两个步骤来使用,首先运行

$ sense grid-baselines <OBSERVATION_CONFIG_FILE.yml>

然后

$ sense calc-sense <SENSITIVITY_CONFIG_FILE.yml> --array-file=<ARRAY_FILE.pkl>

其中ARRAY_FILE在第一步中生成(其位置在执行期间打印)。

运行测试

如何在GitHub工作流程testsuite.yaml中运行测试的示例。简而言之,只需在安装包后在顶级目录中运行pytest

致谢

有关此代码假设的观测策略和其他相关科学信息,请参阅

Pober等人,2013AJ……145……65P

Pober等人,2014ApJ……782……66P

如果您在您的工作中使用此代码,请承认这些论文,并为此存储库提供链接。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

21cmsense-2.0.2.tar.gz (1.5 MB 查看哈希值)

上传时间

构建分布

21cmSense-2.0.2-py3-none-any.whl (259.8 kB 查看哈希值)

上传时间 Python 3

支持者:

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面