Python版本的Oculus-The-eye-into-The-chaos:一个用于非积分环形磁场的综合磁场诊断包
pyoculus的Python项目详细描述
瞳孔
一个Python版本的Oculus-眼睛进入混沌:一个全面的磁场诊断包不可积,环形磁场(和更一般的1 1/2-D或2D哈密顿系统)。Oculus是拉丁语中“眼睛”的意思。在
安装
您可以通过以下方式从PYPI获取包
pip3 install pyoculus
或者
^{pr2}$或者,可以克隆此存储库。在这种情况下,需要额外的步骤来编译SPEC磁场和PJH的FORTRAN接口。见下文。在
使用
只需在Python包中导入:
importpyoculus
示例可以在examples
子文件夹中找到。在
文件
pyoculus的文档由Doxygen管理。在
您可以在Github页面找到文档:https://zhisong.github.io/pyoculus/
本文件将定期更新,但可能不是最新的。要从源代码生成文档,请运行
make doxygen
文档将出现在子文件夹doc/html
中。请在浏览器中打开doc/html/index.html
。在
磁场和压力跳跃哈密顿量(PJH)
需要一些额外的步骤来对由生成的输出运行pyoclus 阶梯压力平衡代码或SPEC。在
先决条件
您需要py_spec
包来读取SPEC输出文件并将其交给pyoculus。然而,py_spec
不是pyoculus的必要条件。Link to py_spec
编译
如果不是通过PYPI获取包,要使用pyoclus on SPEC磁场和PJH,请编译SPEC by的Fortran模块
pip3 install -e .
或者,您可以使用f2py
在pyoculus/problems/SPECfortran
中手动编译*.f90
,以生成一个模块pyoculus_spec_fortran_module
。不建议这样做。在
有关f2py
的文档可以在here找到。在
开发商
- 致松曲(zhisong.qu@anu.edu.au)
- 阿鲁纳夫·库马尔(arunav.kumar@anu.edu.au)
- 斯图亚特·哈德森(shudson@pppl.gov)
原始Oculus软件包的链接:
Github:https://github.com/SRHudson/Oculus
文档:https://w3.pppl.gov/~shudson/Oculus/oculus.pdf
- 项目
标签: