Metrics

[cjayross]

Addresses #4

This adds a total 113* different metrics that can be loaded by using the function load_metric defined in metric.py.

There are currently two issues to be addressed, the first is that the metrics aren't organized and unsearchable; meaning that a user has to manually go into the file where it's defined to actually discover what the metric actually looks like. The second issues is that citations need to be added to each metric that is defined.

>>> from sympy import *
>>> from riccipy import *
>>> g = load_metric('g', 'einstein_maxwell_2')
>>> g.as_array()

* Now 115

[pep8speaks]

Hello @cjayross! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file src/riccipy/metric.py:

Line 267:81: E501 line too long (84 > 80 characters)

• In the file src/riccipy/metrics/bondi_1.py:

Line 12:81: E501 line too long (86 > 80 characters)

• In the file src/riccipy/metrics/bondi_2.py:

Line 12:81: E501 line too long (86 > 80 characters)

• In the file src/riccipy/metrics/bondi_3.py:

Line 15:5: W503 line break before binary operator
Line 17:9: W503 line break before binary operator
Line 19:5: W503 line break before binary operator

• In the file src/riccipy/metrics/datta_2.py:

Line 14:81: E501 line too long (82 > 80 characters)

• In the file src/riccipy/metrics/durgapal_1.py:

Line 16:5: W503 line break before binary operator
Line 17:5: W503 line break before binary operator
Line 18:5: W503 line break before binary operator

• In the file src/riccipy/metrics/durgapal_2.py:

Line 16:5: W503 line break before binary operator
Line 17:5: W503 line break before binary operator
Line 18:5: W503 line break before binary operator
Line 19:81: E501 line too long (88 > 80 characters)
Line 20:9: W503 line break before binary operator

• In the file src/riccipy/metrics/durgapal_3.py:

Line 16:5: W503 line break before binary operator
Line 17:5: W503 line break before binary operator

• In the file src/riccipy/metrics/einstein_2.py:

Line 12:81: E501 line too long (83 > 80 characters)

• In the file src/riccipy/metrics/einstein_maxwell_1.py:

Line 2:81: E501 line too long (109 > 80 characters)

• In the file src/riccipy/metrics/einstein_maxwell_2.py:

Line 2:81: E501 line too long (117 > 80 characters)

• In the file src/riccipy/metrics/einstein_maxwell_3.py:

Line 2:81: E501 line too long (122 > 80 characters)

• In the file src/riccipy/metrics/faulkes.py:

Line 15:81: E501 line too long (87 > 80 characters)

• In the file src/riccipy/metrics/godfrey.py:

Line 2:81: E501 line too long (134 > 80 characters)
Line 14:81: E501 line too long (86 > 80 characters)

• In the file src/riccipy/metrics/griffiths.py:

Line 15:5: W503 line break before binary operator
Line 16:5: W503 line break before binary operator
Line 17:5: W503 line break before binary operator
Line 18:5: W503 line break before binary operator
Line 19:5: W503 line break before binary operator
Line 20:5: W503 line break before binary operator

• In the file src/riccipy/metrics/heintzmann.py:

Line 13:81: E501 line too long (88 > 80 characters)

• In the file src/riccipy/metrics/kasner_1.py:

Line 10:81: E501 line too long (81 > 80 characters)

• In the file src/riccipy/metrics/kerr_1.py:

Line 20:9: W503 line break before binary operator
Line 21:9: W503 line break before binary operator
Line 22:9: W503 line break before binary operator
Line 23:9: W503 line break before binary operator
Line 24:9: W503 line break before binary operator
Line 26:5: W503 line break before binary operator
Line 27:5: W503 line break before binary operator

• In the file src/riccipy/metrics/kerr_2.py:

Line 21:9: W503 line break before binary operator
Line 22:9: W503 line break before binary operator
Line 23:9: W503 line break before binary operator
Line 24:9: W503 line break before binary operator
Line 25:9: W503 line break before binary operator
Line 27:5: W503 line break before binary operator
Line 28:5: W503 line break before binary operator

• In the file src/riccipy/metrics/kerr_3.py:

Line 17:5: W503 line break before binary operator
Line 19:9: W503 line break before binary operator
Line 20:9: W503 line break before binary operator
Line 21:9: W503 line break before binary operator
Line 22:9: W503 line break before binary operator
Line 23:9: W503 line break before binary operator
Line 25:5: W503 line break before binary operator

• In the file src/riccipy/metrics/kerr_newman_1.py:

Line 20:9: W503 line break before binary operator
Line 21:9: W503 line break before binary operator
Line 22:9: W503 line break before binary operator
Line 23:9: W503 line break before binary operator
Line 24:9: W503 line break before binary operator
Line 25:9: W503 line break before binary operator
Line 26:9: W503 line break before binary operator
Line 28:5: W503 line break before binary operator
Line 29:5: W503 line break before binary operator

• In the file src/riccipy/metrics/kerr_newman_2.py:

Line 15:81: E501 line too long (87 > 80 characters)
Line 21:9: W503 line break before binary operator
Line 22:9: W503 line break before binary operator
Line 23:9: W503 line break before binary operator
Line 24:9: W503 line break before binary operator
Line 25:9: W503 line break before binary operator
Line 26:9: W503 line break before binary operator
Line 28:5: W503 line break before binary operator
Line 29:5: W503 line break before binary operator

• In the file src/riccipy/metrics/kottler.py:

Line 2:81: E501 line too long (118 > 80 characters)

• In the file src/riccipy/metrics/levi_civita_1.py:

Line 12:81: E501 line too long (83 > 80 characters)

• In the file src/riccipy/metrics/levi_civita_2.py:

Line 12:81: E501 line too long (83 > 80 characters)

• In the file src/riccipy/metrics/levi_civita_4.py:

Line 12:81: E501 line too long (81 > 80 characters)

• In the file src/riccipy/metrics/levi_civita_5.py:

Line 12:81: E501 line too long (81 > 80 characters)

• In the file src/riccipy/metrics/mcvittie.py:

Line 13:81: E501 line too long (88 > 80 characters)

• In the file src/riccipy/metrics/reissner_nordstrom_2.py:

Line 2:81: E501 line too long (100 > 80 characters)

• In the file src/riccipy/metrics/robertson_walker_1.py:

Line 15:81: E501 line too long (82 > 80 characters)

• In the file src/riccipy/metrics/robertson_walker_2.py:

Line 14:81: E501 line too long (83 > 80 characters)

• In the file src/riccipy/metrics/robertson_walker_3.py:

Line 15:81: E501 line too long (83 > 80 characters)

• In the file src/riccipy/metrics/schwarzschild_1.py:

Line 13:81: E501 line too long (83 > 80 characters)

• In the file src/riccipy/metrics/schwarzschild_5.py:

Line 14:81: E501 line too long (83 > 80 characters)

• In the file src/riccipy/metrics/tolman_3.py:

Line 15:81: E501 line too long (88 > 80 characters)

• In the file src/riccipy/metrics/vaidya_3.py:

Line 2:81: E501 line too long (95 > 80 characters)

• In the file src/riccipy/metrics/vaidya_4.py:

Line 2:81: E501 line too long (94 > 80 characters)

Comment last updated at 2019-07-08 09:56:19 UTC

[cjayross]

I added the citations that I had available. I think there is a couple that are still missing.