物理数据的未分类似然分析包
项目描述
火炬
由@robertdstein创建的天体粒子物理数据的未分类似然分析代码。
可以执行时间相关和时间无关的分析,以及“flare-search”算法来查找时间和空间中的事件聚类。
执行单点源分析,以及根据预定义的权重堆叠源。还执行堆叠分析,其中每个源的信号强度单独拟合。
入门
开始使用flarestack的最简单方法是使用介绍性的ipython笔记本,可以通过以下链接打开:
笔记本本身位于examples/ipython_notebooks/下。
“Binder”提供了一个包含所有必要依赖项的预构建 Docker 映像,因此您只需单击即可播放。它避免了本地安装的需要,并且应该提供对代码如何工作的理解。
安装说明
我如何实际安装flarestack?
这个问题的答案取决于你感觉有多懒,以及你想要处理多少后端。
选项 A:我只想进行分析,并相信引擎盖下的代码
在这种情况下:
pip install flarestack
整个包可以简单地 pip 安装,这将自动安装所有依赖项。
选项 B:实际上,我想自己查看后端代码。也许我想为它做出贡献!
现在您将需要一些额外的代码行:
git clone git@github.com:icecube/flarestack.git
pip install -e flarestack/
这将为您提供最新的代码副本,如果您自己 git pull 或修改脚本,则更新已安装的版本,并且仍然使您能够导入flarestack。
如果您确实想为flarestack做出贡献,您可以在此处查看一些指南。
好吧,无论如何,我现在已经下载了flarestack。我可以马上使用吗?
您可以使用作为代码一部分提供的公共 IceCube 数据集立即开始使用flarestack 。您可以简单地运行脚本,例如 /flarestack/analysiss/ 下的脚本,然后做你的科学!
您可以选择为数据集设置自定义目录,以及存储使用代码计算的数据。
设置数据集目录
如果您在 WIPAC 或 DESY 上运行,则无需指定数据集目录,因为会自动找到 IceCube 数据。否则,您可以添加:
export FLARESTACK_DATASET_DIR=/path/to/datasets
将代码指向 Icecube 数据集的本地副本。
设置存储数据的目录
Flarestack会生成许多不需要版本控制的文件。原理是这个目录下的所有东西都可以通过代码重现,所以不需要备份。默认情况下,这些文件将单独保存在用户主目录中,但最好将它们保存在其他位置,例如临时目录。您可以指定父目录:
export FLARESTACK_SCRATCH_DIR=/path/to/scratch
flarestack__data
将在该目录中创建一个文件夹。在这里您可以找到代码生成的绘图、pickle 文件和其他文件。
测试flarestack
flarestack真的有效吗?您可以使用单元测试检查flarestack的功能。有一套单元测试来涵盖flarestack功能,可以从基础flarestack目录运行:
python -m unittest discover tests/
Flarestack与 Github Actions 一起运行,这是一个持续集成服务。每次提交后,都会运行测试套件,以确保提交不会破坏任何内容。您可以在以下位置查看这些测试的结果:
如果你想为flarestack做出贡献,请记得添加新的测试!目前被测试覆盖的代码部分是使用 Coveralls ( https://coveralls.io/ ) 测量的。根据经验,至少应覆盖 80% 的核心代码,但 >90% 会更好。当前的代码覆盖率是:
使用flarestack进行冰立方分析
如分析自述文件中所述, flarestack目前用于使用未发表的 Monte Carlo 模拟进行内部 IceCube 分析。使用此代码可以使用有效区域对公共 IceCube 数据进行额外分析,但此功能尚未经过测试或完全开发。任何将此代码用于公共数据的行为均未经 IceCube 合作的认可。
引用flarestack
如果您使用flarestack进行分析,请引用它!DOI 由 Zenodo 提供,它可以引用代码存储库或 Flarestack 的特定版本。
贡献者
- 费德里卡·布拉达西奥@fbradascio
- 西蒙娜·加拉帕@simonegarrappa
- 詹尼斯内克尔@JannisNe
- 罗伯特斯坦@robertdstein
项目详情
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。
源分布
内置分布
用于flarestack -2.4.5.tar.gz 的哈希
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 96b630ef86e96bb4a3b30d4ec93d20fb521fbd59a76db3e8bbf885f3cbec210f |
|
MD5 | ce2ba711435adda3b6fae40deb9ea274 |
|
布莱克2-256 | 26de35a4e91bd1b239054196227ded3a0851ab2a54861d579159168fc4612e18 |
flarestack -2.4.5-py3-none-any.whl 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | dca8d6e2800abbf191b1b7f0d0a5caa6e1b4ea834a7f5803b3dee5c15f07f9ec |
|
MD5 | e900995b776303a56849a73d23615f8c |
|
布莱克2-256 | fcec27769bd55d5ff271a011e81828f55c75664b95874308f69b33ef68f65190 |