File: PKG-INFO

package info (click to toggle)
einsteinpy 0.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 11,164 kB
  • sloc: python: 6,046; makefile: 146
file content (283 lines) | stat: -rw-r--r-- 12,453 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
Metadata-Version: 2.1
Name: einsteinpy
Version: 0.3.0
Summary: Python package for General Relativity
Home-page: https://einsteinpy.org/
Author: Shreyas Bapat
Author-email: bapat.shreyas@gmail.com
License: MIT
Download-URL: https://github.com/einsteinpy/einsteinpy
Description: .. 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/0.3.x/COPYING
        
        .. |docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat-square
           :target: https://docs.einsteinpy.org/en/v0.3.0/?badge=latest
        
        .. |codeclimate| image:: https://img.shields.io/codeclimate/maintainability/einsteinpy/einsteinpy.svg?logo=code-climate&style=flat-square
           :target: https://codeclimate.com/github/einsteinpy/einsteinpy/maintainability
           :alt: Maintainability
        
        .. |circleci| image:: https://img.shields.io/circleci/project/github/einsteinpy/einsteinpy/0.3.x.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%3A0.3.x
        
        .. |codecov| image:: https://img.shields.io/codecov/c/github/einsteinpy/einsteinpy.svg?style=flat-square
           :target: https://codecov.io/github/einsteinpy/einsteinpy?branch=0.3.x
        
        .. |appveyor| image:: https://img.shields.io/appveyor/ci/shreyasbapat/einsteinpy/0.3.x?logo=appveyor&style=flat-square
           :target: https://ci.appveyor.com/project/shreyasbapat/einsteinpy/branch/0.3.x
        
        .. |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.3.0
        
        |astropy| |mailing| |gitter| |riotchat| |license| |docs|
        
        |circleci| |ghactions| |appveyor| |codecov| |codeclimate|
        
        **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/0.3.x?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/0.3.x?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 OS X on Python
        3.6, 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/
        
        Testing
        =======
        
        |codecov|
        
        If installed correctly, the tests can be run using pytest::
        
          $ python -c "import einsteinpy.testing; einsteinpy.testing.test()"
          ============================= test session starts ==============================
          platform linux -- Python 3.7.1, pytest-4.3.1, py-1.8.0, pluggy-0.9.0
          rootdir: /home/shreyas/Local Forks/einsteinpy, inifile: setup.cfg
          plugins: remotedata-0.3.1, openfiles-0.3.1, doctestplus-0.3.0, cov-2.5.1, arraydiff-0.3
          collected 56 items
          [...]
          ==================== 56 passed, 1 warnings in 28.19 seconds ====================
          $
        
        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/0.3.x/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/0.3.x/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 <insert nerdy thing> 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/
        
Keywords: general relativity,geodesics,relativity,kerr,black-hole,kerr-newman,schwarzschild
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.5
Provides-Extra: dev