gtrpy 1.5

GTRPy is a python package that allows you to calculate the well-known tensors in General Theory of Relativity.

GTRPy

GTRPy is a python package that allows you to calculate the well-known tensors in General Theory of Relativity, without writing a single line of code. Furthermore, you can apply many operations to 6 different type of fields, in both 4D and 3D.

It's tested for GNU/Linux, however it should also work in MacOS. If you ever encounter with a problem, feel free to create an issue.

Installation (via pip)

You can easily install GTRPy via

python3 -m pip install gtrpy

later on you can install the requirements by running

python3 -m pip install numpy Pillow pysimplegui sympy

Installation (via git)

If you want, you can also directly clone the repository via

git clone https://github.com/seVenVo1d/GTRPy.git

and install the requirements by running

python3 -m pip install -r requirements.txt

Requirements (Extra)

Additionally, you will also need tkinter and LaTeX to properly run the GTRPy. In Fedora, these can be easily installed by running

sudo dnf install python3-tkinter
sudo dnf install texlive-scheme-full

You can look for your distributions package manager and search for an equivalent installation method.

User Guide

To start GTRPy, simply run

python3 -m gtrpy.run

from the terminal (it does not matter what directory you are in, if you are installed it via pip). This will create logs directory under your current directory, which will contain the outputs of the performed operations.

Please take a look at the docs/user_guide.md for a summary of the GTRPy. To see more detailed examples, you can look at the demos directory.

Current Features

GR Tensor Objects

Either by using predefined coordinates, or by defining the coordinate system yourself, you can calculate:

1. Inverse Metric Tensor
2. Christoffel Symbol
3. Riemann Tensor
4. Ricci Tensor
5. Ricci Scalar
6. Weyl Tensor
7. Traceless Ricci Tensor
8. Einstein Tensor
9. Kretschmann Scalar

Field Objects

Currently, there are 6 different field objects that you can carry out operations. These are:

1. Scalar Field
2. Type (1,0) Vector Field
3. Type (0,1) Vector Field
4. Type (2,0) Tensor Field
5. Type (1,1) Tensor Field
6. Type (0,2) Tensor Field

Operations on Fields

1. Varying the type of a given vector field
2. Calculating covariant and Lie derivatives for each field object (scalar, vector and tensor)
3. Checking the Killing field condition for a given vector field

Overview

4D/Main Page	3D/Main Page

4D/Scalar Field Operations	4D/Vector Field Operations	4D/Tensor Field Operations

3D/Scalar Field Operations	3D/Vector Field Operations	3D/Tensor Field Operations

Upcoming Features

1. Raising and lowering indices for a given tensor field
2. Gradient, Divergence, Curl and Laplace operations on fields
3. Partial and Covariant derivatives of the GR Tensors (Christoffel Symbol, Riemann Tensor, etc.)
4. Including more coordinate systems
5. Adding a button that prints the equations in LaTeX form

Contributing

I am looking for developers who would like to contribute to the project. If you are interested, feel free to create an issue by stating how would you like to contribute. Any help or idea is welcomed.