[论文解读] EinsteinPy: A Community Python Package for General Relativity

Shreyas Bapat, Ritwik Saha+47 more|arXiv (Cornell University)|May 22, 2020

Computational Physics and Python Applications参考文献 1被引用 5

一句话总结

EinsteinPy 是一个开源、社区驱动的 Python 软件包，旨在通过可访问、文档齐全且经过充分测试的计算工具，推动广义相对论的研究与教育。它提供用于度量计算、坐标变换、光线追踪、符号张量操作以及超曲面分析的模块，测试覆盖率达 94%，并配备自动化的 CI/CD 工作流，确保代码质量与贡献者的可及性。

ABSTRACT

This paper presents EinsteinPy (version 0.3), a community-developed Python package for gravitational and relativistic astrophysics. Python is a free, easy to use a high-level programming language which has seen a huge expansion in the number of its users and developers in recent years. Specifically, a lot of recent studies show that the use of Python in Astrophysics and general physics has increased exponentially. We aim to provide a very high level of abstraction, an easy to use interface and pleasing user experience. EinsteinPy is developed keeping in mind the state of a theoretical gravitational physicist with little or no background in computer programming and trying to work in the field of numerical relativity or trying to use simulations in their research. Currently, EinsteinPy supports simulation of time-like and null geodesics and calculates trajectories in different background geometries some of which are Schwarzschild, Kerr, and KerrNewmann along with coordinate inter-conversion pipeline. It has a partially developed pipeline for plotting and visualization with dependencies on libraries like Plotly, matplotlib, etc. One of the unique features of EinsteinPy is a sufficiently developed symbolic tensor manipulation utilities which are a great tool in itself for teaching yourself tensor algebra which for many beginner students can be overwhelmingly tricky. EinsteinPy also provides few utility functions for hypersurface embedding of Schwarzschild spacetime which further will be extended to model gravitational lensing simulation.

研究动机与目标

• 开发一个免费、开源且可扩展的 Python 软件包，用于解决广义相对论与引力物理中的问题。
• 通过提供可访问、文档齐全且可交互的工具，支持研究人员和学生模拟相对论性现象。
• 在科学 Python 生态系统中建立协作式、社区驱动的开发模式。
• 通过自动化测试、代码检查和持续集成，提升代码质量并优化贡献者入门体验。
• 通过社区贡献以及参与 GSoC 和 SOCIS 等开源项目，拓展软件功能。

提出的方法

• 采用模块化架构，设立独立组件：度量、坐标、绘图、符号、光线和超曲面模块。
• 使用 Jupyter Notebook 生成并维护交互式示例与文档。
• 通过跨多个 Python 版本和操作系统的自动化测试，实现 94% 的代码覆盖率，确保代码质量。
• 集成持续集成服务（GitHub Actions、CircleCI、Appveyor、Codecov、Codeclimate、Hound），实现自动化代码检查与代码风格检查。
• 采用符合 PEP8 规范的代码风格，并通过 pep8speaks 机器人在拉取请求中提供实时反馈。
• 在每次代码更改时自动重建并发布文档，确保文档与代码的一致性与准确性。

实验结果

研究问题

• RQ1 社区驱动的开源 Python 软件包在多大程度上能有效支持广义相对论的研究与教育？
• RQ2 哪些软件工程实践能够确保科学计算软件包中高代码质量与贡献者可及性？
• RQ3 自动化测试与 CI/CD 工作流在快速演进的科学软件项目中，能在多大程度上维持可靠性？
• RQ4 如何将符号计算与数值光线追踪整合到一个统一、可扩展的框架中，以支持相对论物理研究？
• RQ5 像 GSoC 和 SOCIS 这类开源项目在推动物理学科学软件开发方面发挥着怎样的作用？

主要发现

• 通过全面的测试套件，EinsteinPy 实现了 94% 的代码覆盖率，尽管在测试某些复杂模块时存在挑战，但仍展现出强大的可靠性。
• 该软件包成功实现了在 Windows、macOS 和 Linux 上的自动化 CI/CD 工作流，确保了跨平台兼容性与一致的代码质量。
• 通过 pep8speaks 机器人实现实时代码风格检查，提升了代码一致性，并通过提供人类可读反馈降低了贡献者的协作门槛。
• 项目已吸引超过 50 名贡献者，表明社区参与度高，且在开放科学软件开发中具备可持续性。
• 符号模块于 2019 年 ESA 夏季开源计划（SOCIS）期间开发，验证了开源推广项目在推动科学软件发展方面的有效性。
• 该项目被选为 2020 年 Google 夏季代码计划（GSoC）下 OpenAstronomy 联盟的子组织，凸显其在科学软件社区中的认可度与权威性。