## EinsteinPy

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.

## Examples

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/master?filepath=index.ipynb

## 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 Geodesics, for calculating geodesics in Kerr geometries

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

Installation

The easiest and fastest way to get the package up and running is to install EinsteinPy using conda:

```
$ conda install einsteinpy --channel conda-forge
```

Or you can simply install it from PyPI:

```
$ pip install einsteinpy
```

Or for Debian/Ubuntu/Mint users, the package is installable (Ubuntu 19.04 onwards) from apt:

```
$ 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.