Skip to main content

Differentiable Ray Tracing Toolbox for Radio Propagation Simulations

Project description

DiffeRT logo

DiffeRT

Differentiable Ray Tracing toolbox for Radio Propagation powered by the JAX ecosystem.

Latest Release Python version Documentation DOI Codecov

Usage

WARNING: This package is still under important development, see the v1.0.0 milestone for future features, and the CHANGELOG for versioning policy.

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

The easiest way to install DiffeRT is through pip:

pip install differt

We provide pre-built binaries for most platforms. If you want (or need) to build the package from the source distribution, or want to customize the installation (e.g., with GPU support), check out the installation guide.

Reporting an issue

If you think you found a bug, an error in the documentation, or wish there was some feature that is currently missing, we would love to hear from you!

The best way to reach us is via the GitHub issues. If your problem is not covered by an already existing (closed or open) issue, then we suggest you create a new issue. You can choose from a list of templates, or open a blank issue if your issue does not fit one of the proposed topics.

The more precise you are in the description of your problem, the faster we will be able to help you!

If you rather have a question than a problem, then it is probably best suited to ask it in the Q&A category of the discussions.

Contributing

All types of contributions are more than welcome!

Please follow the contributing guide for a detailed step-by-step procedure.

Citing

If you use this software, please cite it as (preferred):

@inproceedings{Eertmans_DiffeRT_ICMLCN_2025,
  title     = {Demonstrating {DiffeRT}: An Open-Source Library for Optimizing Radio Networks with Differentiable Ray Tracing},
  author    = {Eertmans, Jérome and Oestges, Claude and Jacques, Laurent},
  year      = 2025,
  booktitle = {2025 IEEE International Conference on Machine Learning for Communication and Networking (ICMLCN)},
  volume    = {},
  number    = {},
  pages     = {1--2},
  doi       = {10.1109/ICMLCN64995.2025.11139997}
}

or:

@software{Eertmans_DiffeRT_GitHub,
  title   = {{DiffeRT}: A Differentiable Ray Tracing Toolbox for Radio Propagation Simulations},
  author  = {Eertmans, Jérome},
  url     = {https://github.com/jeertmans/DiffeRT},
  license = {MIT},
  version = {v0.8.0}
}

For other citation formats, please refer to the Cite this repository button the main page of our GitHub repository or to our Zenodo records.

Thank you for using this software and helping us!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

differt-0.8.0.tar.gz (86.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

differt-0.8.0-py3-none-any.whl (99.7 kB view details)

Uploaded Python 3

File details

Details for the file differt-0.8.0.tar.gz.

File metadata

  • Download URL: differt-0.8.0.tar.gz
  • Upload date:
  • Size: 86.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for differt-0.8.0.tar.gz
Algorithm Hash digest
SHA256 1ce96f0afe1f4db99f14eb6fca5299fd328ff8195ebc8d98e77c8f65fbde2a8b
MD5 0d9517091f2c360b1c367622c2684e5f
BLAKE2b-256 2f9aab4bc696db6963529bd54114aeda21e00957ba52f106ec4e8eab7801307c

See more details on using hashes here.

Provenance

The following attestation bundles were made for differt-0.8.0.tar.gz:

Publisher: publish.yml on jeertmans/DiffeRT

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file differt-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: differt-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 99.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for differt-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fb0216782f5844f0b41b038e05778a884bbaed1c08ed58bfdf478af6578e38d5
MD5 9171b0708b1e6a25c463d9f3711a5d7c
BLAKE2b-256 df574ca320eaa3707421f23ecbc9f97c4284ddb7e22f6ad8cf9b00129ab2249c

See more details on using hashes here.

Provenance

The following attestation bundles were made for differt-0.8.0-py3-none-any.whl:

Publisher: publish.yml on jeertmans/DiffeRT

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page