Skip to content

Commit b38d996

Browse files
Update README.md
1 parent 26df1b6 commit b38d996

1 file changed

Lines changed: 31 additions & 16 deletions

File tree

README.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ A Python utility built on Sympy (A symbolic mathematics library) which will anal
77

88
Prerequisites
99
=============
10+
1011
1.) Install Python3
1112

1213
$ sudo apt install python3
@@ -15,40 +16,54 @@ Prerequisites
1516

1617
$ sudo apt install python3-pip
1718

18-
Installation with pip (In development)
19+
Installation with pip
1920
=====================
2021

21-
$ pip3 install sympy spacetimeengine
22+
1.) Install with pip
23+
24+
$ pip3 install spacetimeengine
25+
26+
2.) Enter python shell
27+
28+
$ python3
2229

30+
3.) Import spacetimeengine
31+
32+
>> from spacetimeengine import *
33+
34+
4.) Create a SpaceTime object which describes the Schwarzschild spacetime
35+
36+
>> schwarzschild_spacetime = SpaceTime(Solution().schwarzschild())
37+
38+
5.) Enjoy watching the coefficients get computed.
39+
2340
Installation with git
2441
=====================
2542

26-
3.) Clone repository
43+
1.) Clone repository
2744

2845
$ git clone https://github.com/spacetimeengineer/spacetimeengine
2946

30-
4.) Enter directory
47+
2.) Enter directory
48+
49+
$ cd spacetimeengine/spacetimeengine/samples
50+
51+
3.) Run example.py
3152

32-
$ cd spacetimeengine
53+
$ python3 example.py
3354

3455
Suggested Use
3556
=============
36-
If you are a student or researcher and find yourself reading a publication based in General Relativity which provides metric values then this utility can be used for working out the curvature coefficients that associate with the metric. This can be helpful as you read through the publication since you will be able to cross reference the information provided by the toolkit and the publication for richer analysis (This is why I developed it originally).
37-
38-
Running example.py
39-
==================
40-
Example.py is a good choice for someone new to the project becasue it demonstrates the functionality suite. Depending on the metric you use for input, the compute time may vary exponentially. There are other metric solutions available for study in the Solutions module. To change the metric just swap it out for another one or build your own. There are many metric examples to help you understand how to build input parameters.
41-
42-
$ python example.py
57+
If you are a student or researcher and find yourself reading a publication based in General Relativity which provides metric solutions then this utility can be used for working out the curvature coefficients which associate with the solution. This can be a helpful utility as you read through the literature since you will be able to cross reference the information provided by the literature with the values the spacetimeengine provides (This is why I developed it originally). Also this utility can be used for error checking.
4358

4459
[Metric Tensor](https://en.wikipedia.org/wiki/Metric_tensor)
4560
===============
4661

47-
Generally speaking, any metric solution to the Einstein field equations will be packaged into a geometric object known as the metric tensor. The metric tensor is often represented in matrix form and SpacetimeEngine adopts this representation.
62+
Generally speaking, any metric solution to the Einstein field equations will be packaged into a geometric object known as the metric tensor. The metric tensor is often represented in matrix form and the spacetimeengine package adopts this representation.
4863

4964
![equation](https://latex.codecogs.com/png.latex?%5Cdpi%7B100%7D%20%5Chuge%20%5Cbegin%7Bpmatrix%7D%20%5Cleft%20%28%201-%20%5Cfrac%7B2GM%7D%7Brc%5E2%7D%20%5Cright%20%29%20%26%200%20%26%200%26%200%5C%5C%200%26%20-%5Cleft%20%28%201-%20%5Cfrac%7B2GM%7D%7Brc%5E2%7D%20%5Cright%20%29%5E%7B-1%7D%26%200%26%200%5C%5C%200%26%200%26%20-r%5E%7B2%7D%20%26%200%5C%5C%200%26%200%26%200%26%20-r%5E%7B2%7D%5Csin%5E%7B2%7D%5Ctheta%20%5Cend%7Bpmatrix%7D)
5065

51-
SpacetimeEngine employs the Sympy 'Matrix' object for packaging the metric tensor and it serves as the essential parameter for constructing a 'SpaceTime' object. The Solutions module currently stores some well known metrics for study but these can be used for understanding how to construct a new solution for study.
66+
The spacetimeengine package employs the Sympy 'Matrix' object for packaging the metric tensor and it serves as the essential parameter for constructing a 'SpaceTime' object. The Solutions module currently stores some well known metrics for study but these can be used for understanding how to construct a new solutions.
5267

5368
Constructing a solution (In development)
5469
=======================
@@ -93,11 +108,11 @@ To construct a 'SpaceTime' object just execute the below command and consider th
93108

94109
>>> spacetime = SpaceTime(Solution().schwarzschild())
95110

96-
The index configuration in this case is "dd" which represents down-down which represents a double covariant index configuration. These can be "uu", "dd", "ud", "du" but this library currently only supports
111+
The index configuration in this case is "dd" which represents a down-down configuration which reflects a double covariant index configuration. These can be "uu", "dd", "ud", "du" but this library currently only supports certain index configurations depending on the quantity in question.
97112

98113
[Stress-Energy-Momentum Tensor](https://en.wikipedia.org/wiki/Stress%E2%80%93energy_tensor)
99114
=============================
100-
The Einstein field equations describe the equivilence of space-time curvature and mass-energy. The mass-energy is represented by the coefficents encompassed within the stress-energy-momentum tensor denoted by T_{\mu\nu}. The cosmological constant denoted by Lambda is treated as an input parameter and represents the dark energy thought to be responsble for the accellerated expansion of the cosmos.
115+
The Einstein field equations describe the equivilence of space-time curvature to mass-energy. The mass-energy is described by the coefficents encompassed within the stress-energy-momentum tensor denoted by T_{\mu\nu}. The cosmological constant denoted by Lambda is treated as an input parameter (since it is independent of the metric in most cases) and represents the dark energy thought to be responsble for the accellerated expansion of the cosmos.
101116

102117
![equation](https://latex.codecogs.com/png.latex?%5Cdpi%7B100%7D%20%5Chuge%20T_%7B%5Cmu%20%5Cnu%20%7D%3D%7B%5Cfrac%20%7Bc%5E%7B4%7D%7D%7B8%5Cpi%20G%7D%7D%5Cleft%20%28%20G_%7B%5Cmu%20%5Cnu%20%7D+%5CLambda%20g_%7B%5Cmu%20%5Cnu%20%7D%20%5Cright%20%29)
103118

0 commit comments

Comments
 (0)