Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeertmans/differt
Differentiable Ray Tracing Toolbox for Radio Propagation Simulations
https://github.com/jeertmans/differt
differentiable-simulations radio-propagation raytracing
Last synced: about 4 hours ago
JSON representation
Differentiable Ray Tracing Toolbox for Radio Propagation Simulations
- Host: GitHub
- URL: https://github.com/jeertmans/differt
- Owner: jeertmans
- License: mit
- Created: 2023-10-31T11:07:52.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-04-30T14:50:47.000Z (5 months ago)
- Last Synced: 2024-05-02T03:42:06.563Z (5 months ago)
- Topics: differentiable-simulations, radio-propagation, raytracing
- Language: Python
- Homepage: https://differt.eertmans.be
- Size: 1.57 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
# DiffeRT
[![Latest Release][pypi-version-badge]][pypi-version-url]
[![Python version][pypi-python-version-badge]][pypi-version-url]
[![Documentation][documentation-badge]][documentation-url]
[![DOI][doi-badge]][doi-url]
[![Codecov][codecov-badge]][codecov-url]
## Usage
> [!WARNING]
> Until this package reaches version `0.1.x`, breaking changes
> should be expected. Checkout the [ROADMAP](./ROADMAP.md) for
> future features.
>
> If you have any suggestion regarding the development of this package,
> please open an [issue](https://github.com/jeertmans/DiffeRT/issues).
The easiest way to install DiffeRT is through pip:
```bash
pip install differt
```
We provide pre-built binaries for most platforms. If you want (or need)
to build the package from the source distribution, check out the
requirements below.
## Contributing
> [!IMPORTANT]
> The current documentation is very light and a more complete guide for
> new contributors will be written in the near future.
>
> Until then, do not hesitate to reach me for help with
> [GitHub issues](https://github.com/jeertmans/DiffeRT/issues)!
This project is built using both Python and Rust code, to provide an easy-to-use
but performant program. It also heavily uses the capabilities brought by
[JAX](https://github.com/google/jax) for numerical arrays.
### Requirements
To run build this package locally, you need:
- [Python 3.10](https://www.python.org/) or above;
- [Rust](https://www.rust-lang.org/) stable toolchain;
- any modern C compiler;
- [just](https://github.com/casey/just) to easily run commands listed in `justfile`s;
- [Maturin](https://www.maturin.rs/) for building Python bindings from Rust code;
- and [uv](https://docs.astral.sh/uv/) to manage this project.
This project contains `justfile`s with recipes[^1] for most common
use cases, so feel free to use them instead of the commands listed below/
[^1]: `just` is as alternative tool to Make, that provides more modern
user experience. Enter `just` to list all available recipes.
## Local development
The following commands assume that you installed
the project locally with:
```bash
uv sync
```
and that you activated the corresponding Python virtual environment:
```bash
. .venv/bin/activate # or .venv\Scripts\activate on Windows
```
### Documentation
To generate the documentation, please run the following:
```bash
just docs/build
```
Finally, you can open `docs/build/html/index.html` to see the generated docs.
Other recipes are available, and you can list them with `just docs/`.
### Testing
Both Rust and Python codebases have their own tests and benchmarks.
#### Testing Rust code
You can test Rust code using Cargo:
```bash
cargo test
```
or benchmark it:
```bash
cargo bench
```
#### Testing Python code
Similarly, you can test Python code with Pytest:
```bash
pytest
```
or benchmark it:
```bash
pytest --benchmark-enable differt/tests/benchmarks
```
[pypi-version-badge]: https://img.shields.io/pypi/v/DiffeRT?label=DiffeRT&color=blueviolet
[pypi-version-url]: https://pypi.org/project/DiffeRT/
[pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/DiffeRT?color=orange
[documentation-badge]: https://readthedocs.org/projects/differt/badge/?version=latest
[documentation-url]: https://differt.readthedocs.io/latest/?badge=latest
[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.11386432.svg
[doi-url]: https://doi.org/10.5281/zenodo.11386432
[codecov-badge]: https://codecov.io/gh/jeertmans/DiffeRT/branch/main/graph/badge.svg?token=v63alnTWzu
[codecov-url]: https://codecov.io/gh/jeertmans/DiffeRT