DiffeRT 0.0.10

Differentiable Ray Tracing Toolbox for Radio Propagation Simulations

DiffeRT

Usage

[!WARNING] Until this package reaches version 0.1.x, breaking changes should be expected. Checkout the ROADMAP for future features.

If you have any suggestion regarding the development of this package, please open an issue.

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!

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 for numerical arrays.

Requirements

To run build this package locally, you need:

• Python 3.9 or above;
• Rust stable toolchain;
• Maturin for building Python bindings from Rust code;
• and PDM to manage all Python dependencies.

Building locally

You can build the project locally using:

pdm install

Documentation

To generate the documentation, please run the following:

cd docs
pdm run make html

Finally, you can open build/html/index.html to see the generated docs.

Testing

Both Rust and Python codebases have their own tests and benchmarks.

Testing Rust code

You can very easily test you code using Cargo:

cargo test

or benchmark it:

cargo bench

Testing Python code

in the same way, you can very test you code with Pytest:

pdm run pytest

or benchmark it:

pdm run pytest --benchmark-only