Metadata-Version: 2.4
Name: CRiman
Version: 0.1.1
Summary: A user-friendly package to estimate the Christoffel symbol, Riemann curvature tensors and Ricci tensors
Home-page: https://github.com/ritwik-das/CRiman
Author: Ritwik Das
Author-email: ritwikdas511@gmail.com
License: MIT
Requires-Python: >= 3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.24
Requires-Dist: sympy>=1.13.3
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

<h1 align="left">
  <img src="logo.png" width="60" valign="middle"> <b>CRiman</b> (<b>C</b>hristoffel - <b>Ri</b>cci - Rie<b>man</b>n)
</h1>



A general toolkit for fast calculation of Christoffel symbols, Riemann curvature tensor (mixed and covariant) and Ricci tensor with Ricci scalar.

<br>

### Installation

```bash
pip install criman
```

<br>

### Recommended

CRiman uses `IPython.display.display()` to render each tensor component as typeset LaTeX, so it's built to be run inside a Jupyter/IPython frontend (Jupyter Notebook, JupyterLab, Colab or IPython console) that supports rich display, not a bash or `python script.py` since there's no rich-display backend to catch the `display()` calls.
