hisparc实验的框架
hisparc-sapphire的Python项目详细描述
简介
蓝宝石是一个用于HiSPARC研究和教育的模拟和分析程序包。它是在 完成David Fokkema博士研究的过程。这段历史 存储库包含完整的模拟、分析和绘图生成代码 这是大卫的thesis的基础。 Arne de Laat在自己攻读博士学位的同时接管了蓝宝石的研发工作 研究。
这个存储库是为了唯一的目的而创建的:启用HiSPARC 学生、教师和研究人员可以方便地获取数据和 执行常见的模拟和分析任务。历史上,开始工作 关于数据,或者扩展现有的分析代码,涉及 详细的安装说明,对软件的大量定制, 无数个小时的代码不透明部分和 痛苦和绝望。赛法尔的终极目标是:不要再这样了。
安装
必需:python。pip将处理依赖关系,但是安装 首选来自python发行版的numpy、scipy和pytables。我们用 miniconda,包括conda包管理器。
首先,install conda 或者创建一个virtualenv:
$ conda create --name hisparc python numpy scipy pytables $ source activate hisparc
或者只安装依赖项:
$ conda install numpy scipy pytables sphinx
然后,使用pip:
$ pip install hisparc-sapphire
这应该安装蓝宝石与所有的要求。更广泛 有关安装说明,请参阅 doc/目录。可以使用sphinx编译它们,也可以 按此链接:https://docs.hisparc.nl/sapphire/。
要检查它是否工作,请启动python并加载包:
importsapphire
你完了!
开发
如上所述安装python(最好使用conda),但克隆 sapphire repo而不是使用pip安装:
$ git clone https://github.com/HiSPARC/sapphire.git $ cd sapphire $ python setup.py develop
版本发布
重要提示:首先检查最后一次提交是否通过travis ci上的测试!
若要发布新版本,请在setup.py中修改版本号。那么 为新版本创建一个提交,标题类似“bump version to vx.y.z” 以及包含自 最后一次释放。然后标记提交并将其推送到github:
$ git tag vX.Y.Z $ git push --tags
然后将新版本上传到pypi(这需要wheel和twine 套餐:
$ python setup.py sdist bdist_wheel $ twine upload dist/hisparc-sapphire-X.Y.Z.tar.gz $ twine upload dist/hisparc_sapphire-X.Y.Z-py2.py3-none-any.whl
然后,pypi提供了最新版本。