PIC代码的后处理与可视化
nata的Python项目详细描述
在
Nata是一个用于后处理和可视化模拟的python包 单元代码中粒子的输出。它利用numpy接口提供 读取、操作和表示模拟输出的简单方法。在
安装nata
Nata在PyPI上可用。您可以通过运行以下命令来安装它 在你的终端里指挥
pip install nata
它可以在IPython shell中使用,也可以一起使用jupyter notebook 使用ipywidgets。因此,你 可能需要在安装后运行
^{pr2}$如果你想在JupyterLab内部使用它(注意这需要nodejs) 待安装)
jupyter labextension install @jupyter-widgets/jupyterlab-manager
如有问题,请访问installation section of ipywidgets 更多细节。在
为娜塔做贡献
对nata的任何形式的贡献都是值得赞赏的。如果你有什么问题, 请报告他们by adding an issue on GitHub。但是如果 如果您希望直接为nata提供帮助,我们建议您设置一个本地 发展环境。请按照下面的说明获取更多详细信息。在
获取源代码
源代码托管在GitHub上。只需创建一个叉子并应用 变化。您总是可以将任何更改推送到您的本地fork,但是如果您愿意 想分享你的贡献,请创建一个拉请求,这样就可以了 被审查。在
当地发展环境
对于本地开发环境,我们使用 poetry。这使我们能够更好地处理 依赖性问题和确保编码标准没有负担 手动修复和检查样式。要使用诗歌,只需安装它 通过在终端中运行以下命令来使用最新版本。在
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
然后,干脆跑
poetry install
它将在
虚拟环境。如果您希望在虚拟机内部运行命令
环境,只需按poetry run <your command>
运行它,例如,运行所有
测试
poetry run pytest tests
或者,您可以通过运行 命令
poetry shell
这将在虚拟环境中生成一个shell。有了这个,你可以 甚至在源目录之外运行jupyter。在
此外,我们使用pre-commit来帮助我们保持 我们发展的一致性没有任何额外的负担。请使用它 也。在存储库的根目录中,运行命令
poetry run pre-commit install
这将为您创建提交钩子,并修改保持一致的文件 结构。在
学分
Nata由Anton Helm创建和维护 和Fábio Cruz。在
开发得到Group for Lasers and Plasmas (GoLP)的支持。在
- 项目
标签: