Skip to content
This repository has been archived by the owner on Jul 23, 2019. It is now read-only.

Latest commit

 

History

History
207 lines (131 loc) · 7.07 KB

README.rst

File metadata and controls

207 lines (131 loc) · 7.07 KB
Name:RicciPy
Website:https://riccipy.einsteinpy.org/
Version: 0.1.dev0

mailing Join the chat at https://gitter.im/EinsteinPy-Project/EinsteinPy riotchat license docs

circleci travisci appveyor codecov Maintainability

RicciPy is an open source package that exists as part of The EinsteinPy Project for the purpose of providing a API that makes tensor algebra as easy as possible on arbitrary manifolds. RicciPy implements the use of Sympy for representing tensor equations and expressions symbolically with automatic applications of a metric when contracting indices. Lastly, the Library also provides a means for converting the results of tensor equations to numpy-like functions for use in numerical calculations. 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://doc.riccipy.einsteinpy.org/

Requirements

RicciPy requires the following Python packages:

  • NumPy, for basic numerical routines
  • SymPy, for symbolic calculations related to GR.

Problems

If the installation fails or you find something that doesn't work as expected, please open an issue in the issue tracker.

Contributing

RicciPy is a community project, hence all contributions are more than welcome! For more information, head to 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!

https://groups.io/g/einsteinpy-dev

Please join our [matrix] channel or gitter chat room for further queries.

If you still have a doubt, write a mail directly to [email protected].

Citing

If you use EinsteinPy on your project, please drop us a line.

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: riccipy 0.1.0. Zenodo. 10.5281/zenodo.2582388

License

license

RicciPy is released under the MIT license, hence allowing commercial use of the library. Please refer to COPYING.