Merge branch 'main' of github.com:ThomasHelfer/TorchGRTL into main

README.md

@@ -1,9 +1,49 @@
 ![Unittest](https://github.com/ThomasHelfer/TorchGRTL/actions/workflows/actions.yml/badge.svg)
 
 # TorchGRTL
-A translation of crucial parts of GRTL in torch for accelerated learning
 
-Installation 
-============
+## Overview
+TorchGRTL (Torch General Relativity Toolkit) is a Python library that provides a PyTorch-based implementation of key components of [GRTL codebase](https://example.com](https://github.com/GRTLCollaboration/GRChombo)) . It leverages the power of PyTorch to accelerate computations, making it suitable for machine learning applications in physics and simulation.
 
-To install this code, run ``pip install .`` in the root directory. This code also has pre-commit hooks, to use this please run ``pre-commit install``
+## Features
+- Efficient PyTorch-based computations for general relativity simulations.
+- Integration with machine learning workflows.
+
+## Installation
+
+### Prerequisites
+Before installing TorchGRTL, ensure you have the following prerequisites:
+- Python 3.8 or higher
+- pip package manager
+
+### Steps
+1. Clone the TorchGRTL repository:
+
+   ```bash
+   git clone https://github.com/ThomasHelfer/TorchGRTL.git
+   cd TorchGRTL
+   ```
+
+2. Install the package:
+
+   ```bash
+   Copy code
+   pip install .
+   ```
+3. (Optional) Set up pre-commit hooks for code formatting and linting:
+
+   ```bash
+   pre-commit install
+   ```
+<!-- 
+Usage
+(Provide a brief introduction on how to use the library, perhaps with a simple example.)
+-->
+
+### License
+
+TorchGRTL is released under the MIT License. See LICENSE for more details.
+
+### Contact
+
+For questions or support, please contact Thomas Helfer at [email protected].