einsteinpy

Repository for the EinsteinPy core package πŸš€

Showing:

Popularity

Downloads/wk

0

GitHub Stars

401

Maintenance

Last Commit

5mos ago

Contributors

73

Package

Dependencies

23

License

MIT

Categories

Readme

.. einsteinpy

.. image:: https://blog.einsteinpy.org/img/logo.png :target: https://einsteinpy.org/ :alt: EinsteinPy logo :width: 675px :align: center

.. |astropy| image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat-square :target: http://www.astropy.org/

.. |mailing| image:: https://img.shields.io/badge/mailing%20list-groups.io-8cbcd1.svg?style=flat-square :target: https://groups.io/g/einsteinpy-dev

.. |doi| image:: https://zenodo.org/badge/168302584.svg?style=flat-square :target: https://zenodo.org/badge/latestdoi/168302584

.. |gitter| image:: https://img.shields.io/gitter/room/EinsteinPy-Project/EinsteinPy.svg?logo=gitter&style=flat-square :alt: Join the chat at https://gitter.im/EinsteinPy-Project/EinsteinPy :target: https://gitter.im/EinsteinPy-Project/EinsteinPy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

.. |riotchat| image:: https://img.shields.io/matrix/einsteinpy:matrix.org.svg?logo=riot&style=flat-square :target: https://riot.im/app/#/room/#einsteinpy:matrix.org

.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square :target: https://github.com/einsteinpy/einsteinpy/raw/main/COPYING

.. |docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat-square :target: https://docs.einsteinpy.org/en/latest/?badge=latest

.. |circleci| image:: https://img.shields.io/circleci/project/github/einsteinpy/einsteinpy/main.svg?style=flat-square&logo=circleci :target: https://circleci.com/gh/einsteinpy/einsteinpy

.. |ghactions| image:: https://img.shields.io/github/workflow/status/einsteinpy/einsteinpy/Test_MacOS?logo=github&style=flat-square :target: https://github.com/einsteinpy/einsteinpy/actions?query=branch%3Amain

.. |codecov| image:: https://img.shields.io/codecov/c/github/einsteinpy/einsteinpy.svg?style=flat-square :target: https://codecov.io/github/einsteinpy/einsteinpy?branch=main

.. |appveyor| image:: https://img.shields.io/appveyor/ci/shreyasbapat/einsteinpy/main?logo=appveyor&style=flat-square :target: https://ci.appveyor.com/project/shreyasbapat/einsteinpy/branch/main

.. |orcid-shreyas| image:: https://img.shields.io/badge/id-0000--0002--0870--4665-a6ce39.svg :target: https://orcid.org/0000-0002-0870-4665

:Name: EinsteinPy :Website: https://einsteinpy.org/ :Version: 0.5.dev0

|astropy| |mailing| |gitter| |riotchat| |license| |docs|

|circleci| |ghactions| |appveyor| |codecov|

EinsteinPy is an open source pure Python package dedicated to problems arising in General Relativity and gravitational physics, such as geodesics plotting for Schwarzschild, Kerr and Kerr Newman space-time model, calculation of Schwarzschild radius, calculation of Event Horizon and Ergosphere for Kerr space-time. Symbolic Manipulations of various tensors like Metric, Riemann, Ricci, Ricci Scalar, Weyl, Schouten, Stress-Energy-Momentum, Einstein and Christoffel Symbols is also possible using the library. EinsteinPy also features Hypersurface Embedding of Schwarzschild space-time, which will soon lead to modelling of Gravitational Lensing! It is released under the MIT license.

Documentation

|docs|

Complete documentation, including a user guide and an API reference, can be read on the wonderful Read the Docs_.

https://docs.einsteinpy.org/

.. _Read the Docs: https://readthedocs.org/

Examples

.. |mybinder| image:: https://img.shields.io/badge/launch-binder-e66581.svg?style=flat-square :target: https://beta.mybinder.org/v2/gh/einsteinpy/einsteinpy/main?filepath=index.ipynb

|mybinder|

In the examples directory, you can find several Jupyter notebooks with specific applications of einsteinpy. You can consider theses Jupyter Notebooks as tutorials for einsteinpy. You can launch a cloud Jupyter server using binder_ to edit the notebooks without installing anything. Try it out!

https://beta.mybinder.org/v2/gh/einsteinpy/einsteinpy/main?filepath=index.ipynb

.. _binder: https://beta.mybinder.org/

Requirements

EinsteinPy requires the following Python packages:

  • NumPy, for basic numerical routines
  • Astropy, for physical units and time handling
  • Matplotlib, for static geodesics plotting and visualizations.
  • Plotly, for interactive geodesics plotting and visualizations.
  • SciPy, for solving ordinary differential equations.
  • SymPy, for symbolic calculations related to GR.
  • Numba, for accelerating the code

EinsteinPy is usually tested on Linux, Windows and macOS on Python 3.7 and 3.8, against latest NumPy.

============== =============== =================== Platform Site Status ============== =============== =================== Linux CircleCI |circleci| OS X Github Actions |ghactions| Windows x64 Appveyor |appveyor| ============== =============== ===================

Installation

The easiest and fastest way to get the package up and running is to install EinsteinPy using conda <http://conda.io>_::

$ conda install einsteinpy --channel conda-forge

Or you can simply install it from PyPI <https://pypi.org/>_::

$ pip install einsteinpy

Or for Debian/Ubuntu/Mint users, the package is installable (Ubuntu 19.04 onwards) from apt <https://packages.debian.org/sid/python3-einsteinpy>_::

$ sudo apt install python3-einsteinpy

Please note that the package version in Debian Repositories might not be the latest. But it will be definitely the most stable version of EinsteinPy available till date.

Please check out the guide for alternative installation methods_.

.. _guide for alternative installation methods: https://einsteinpy.github.io/installation/

Problems

If the installation fails or you find something that doesn't work as expected, please open an issue in the issue tracker_.

.. _issue tracker: https://github.com/einsteinpy/einsteinpy/issues

Contributing

EinsteinPy is a community project, hence all contributions are more than welcome! For more information, head to CONTRIBUTING.rst_.

.. _CONTRIBUTING.rst: https://github.com/einsteinpy/einsteinpy/blob/main/CONTRIBUTING.rst

Developers Documentation can be found here.

Support

|mailing|

Release announcements and general discussion take place on our mailing list_. Feel free to join!

.. _mailing list: https://groups.io/g/einsteinpy-dev

https://groups.io/g/einsteinpy-dev

Please join our [matrix] channel or gitter chat room for further queries.

.. _[matrix]: https://matrix.to/#/#einsteinpy:matrix.org

.. _gitter: https://gitter.im/EinsteinPy-Project/EinsteinPy

If you still have a doubt, write a mail directly to all@einsteinpy.org <mailto:all@einsteinpy.org>_.

Citing

If you use EinsteinPy on your project, please drop us a line <mailto:all@einsteinpy.org>_.

You can also use the DOI to cite it in your publications. This is the latest one:

|doi|

And this is an example citation format::

Shreyas Bapat et al.. (2019). EinsteinPy: einsteinpy 0.1.0. Zenodo. 10.5281/zenodo.2582388

License

|license|

EinsteinPy is released under the MIT license, hence allowing commercial use of the library. Please refer to COPYING_.

.. _COPYING: https://github.com/einsteinpy/einsteinpy/blob/main/COPYING

FAQ

Why Einstein-Py?

EinsteinPy comes from the name of the famous physicist, Nobel laureate, revolutionary person, Prof. Albert Einstein. This is a small tribute from our part for the amazing work he did for the humanity!

Can I do with EinsteinPy?

EinsteinPy is focused on general relativity. One can always discuss probable features on the mailing list and try to implement it. We welcome every contribution and will be happy to include it in EinsteinPy.

What's the future of the project?

EinsteinPy is actively maintained and we hope to receive an influx of new contributors. The best way to get an idea of the roadmap is to see the Milestones_ of the project.

.. _Milestones: https://github.com/einsteinpy/einsteinpy/milestones

Inspiration

The whole documentation and code structure is shamelessly inspired by poliastro_ . We really thank the poliastro developers to make this possible. EinsteinPy is nothing without it's supporters.

.. _poliastro: https://docs.poliastro.space/

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100