HiSPARC实验的框架
项目描述
简介
SAPPHiRE 是为 HiSPARC 研究和教育而设计的仿真和分析程序包。它是在完成 David Fokkema 的博士研究过程中创建的。这个存储库的历史包含了构成 David 的 论文 的完整仿真、分析和绘图生成代码。Arne de Laat 在他的博士研究过程中接管了 SAPPHiRE 的发展。
此存储库的创建只有一个目的：使 HiSPARC 的学生、教师和研究人员能够轻松访问数据和执行常见的仿真和分析任务。从历史上看，开始对数据进行工作或扩展现有的分析代码，需要复杂的安装说明，对软件进行大量自定义，花费无数小时审查代码的晦涩部分，以及普遍的痛苦和绝望感。SAPPHiRE 的最终目标：不再如此。
安装
要求：Python。pip 会处理依赖关系，但建议从 Python 发行版中安装 numpy、scipy 和 pytables。我们使用 miniconda，其中包含 conda 包管理器。
首先，安装 conda 并可选地创建一个虚拟环境
$ conda create --name hisparc python numpy scipy pytables $ source activate hisparc
或者，只需安装依赖关系
$ conda install numpy scipy pytables sphinx
然后，使用 pip
$ pip install hisparc-sapphire
这将安装带有所有要求的 sapphire。更详细的安装说明可以在 doc/ 目录中的文档中找到。您可以使用 Sphinx 编译它们，或者您可以通过此链接：https://docs.hisparc.nl/sapphire/。
要检查是否成功，请启动 Python 并加载该包
import sapphire您完成了！
开发
如上所述安装 python（最好使用 conda），但请使用 git 克隆 sapphire 仓库而不是使用 pip 安装
$ git clone https://github.com/HiSPARC/sapphire.git $ cd sapphire $ pip install -e .[dev]
版本发布
重要：首先检查最新的提交是否在 GitHub Actions 上通过测试！
要发布新版本，请修改 setup.py 中的版本号。然后为新版本创建一个带有类似“将版本提升到 vX.Y.Z”的标题和包含自上次发布以来最重要的更改摘要的消息的提交。然后标记该提交并将其推送到 GitHub
$ git tag vX.Y.Z $ git push --tags
然后，将新版本上传到 PyPI（这需要 build、wheel 和 twine 包）
$ python -m build $ twine upload dist/hisparc-sapphire-X.Y.Z.tar.gz $ twine upload dist/hisparc_sapphire-X.Y.Z-py3-none-any.whl
最新版本将随后在 PyPI 上可用。
