differt
Differentiable Ray Tracing Toolbox for Radio Propagation Simulations
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (17.3%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Differentiable Ray Tracing Toolbox for Radio Propagation Simulations
Basic Info
- Host: GitHub
- Owner: jeertmans
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://differt.eertmans.be
- Size: 36.9 MB
Statistics
- Stars: 36
- Watchers: 2
- Forks: 5
- Open Issues: 9
- Releases: 48
Topics
Metadata Files
README.md
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:
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, 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:
bibtex
@software{Eertmans_Differentiable_Ray_Tracing,
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.5.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!
Owner
- Name: Jérome Eertmans
- Login: jeertmans
- Kind: user
- Location: Belgium
- Company: UCLouvain
- Website: https://eertmans.be/
- Repositories: 115
- Profile: https://github.com/jeertmans
PhD student, with a Master in Electromechanical Engineering
Citation (CITATION.cff)
cff-version: 1.2.0
title: >-
DiffeRT: A
Differentiable Ray Tracing Toolbox for Radio Propagation
Simulations
message: 'If you use this software, please cite us.'
type: software
authors:
- family-names: Eertmans
given-names: Jérome
orcid: 'https://orcid.org/0000-0002-5579-5360'
identifiers:
- type: doi
value: 10.5281/zenodo.11386432
description: Zenodo Archive
repository-code: 'https://github.com/jeertmans/DiffeRT'
url: 'https://eertmans.be/DiffeRT'
abstract: Differentiable Ray Tracer for Radio-Propagation Modeling.
keywords:
- Ray Tracing
- Differentiable
- JAX
- Radio Propagation
- Modeling
license: MIT
version: v0.5.0
GitHub Events
Total
- Create event: 159
- Commit comment event: 4
- Issues event: 13
- Release event: 32
- Watch event: 26
- Delete event: 141
- Issue comment event: 181
- Push event: 611
- Pull request review event: 46
- Pull request review comment event: 152
- Pull request event: 238
- Fork event: 4
Last Year
- Create event: 159
- Commit comment event: 4
- Issues event: 13
- Release event: 32
- Watch event: 26
- Delete event: 141
- Issue comment event: 181
- Push event: 611
- Pull request review event: 46
- Pull request review comment event: 152
- Pull request event: 238
- Fork event: 4
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Jérome Eertmans | j****s@i****m | 408 |
| github-actions[bot] | 4****] | 59 |
| dependabot[bot] | 4****] | 21 |
| pre-commit-ci[bot] | 6****] | 16 |
| imgbot[bot] | 3****] | 1 |
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 12
- Total pull requests: 410
- Average time to close issues: 18 days
- Average time to close pull requests: 3 days
- Total issue authors: 3
- Total pull request authors: 5
- Average comments per issue: 0.42
- Average comments per pull request: 1.64
- Merged pull requests: 367
- Bot issues: 0
- Bot pull requests: 148
Past Year
- Issues: 8
- Pull requests: 248
- Average time to close issues: 27 days
- Average time to close pull requests: 2 days
- Issue authors: 3
- Pull request authors: 3
- Average comments per issue: 0.5
- Average comments per pull request: 1.4
- Merged pull requests: 228
- Bot issues: 0
- Bot pull requests: 85
Top Authors
Issue Authors
- jeertmans (11)
- ogencoglu (1)
- fanyimeng0 (1)
Pull Request Authors
- jeertmans (326)
- github-actions[bot] (135)
- dependabot[bot] (39)
- pre-commit-ci[bot] (5)
- imgbot[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 523 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 46
- Total maintainers: 1
pypi.org: differt
Differentiable Ray Tracing Toolbox for Radio Propagation Simulations
- Homepage: https://github.com/jeertmans/DiffeRT
- Documentation: https://eertmans.be/DiffeRT
- License: MIT License
-
Latest release: 0.5.0
published 7 months ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v4 composite
- actions/checkout v4 composite
- actions/setup-python v4 composite
- thollander/actions-comment-pull-request v2 composite
- chex ^0.1.84
- jax ^0.4.20
- jaxtyping ^0.2.23
- matplotlib ^3.8.1
- numpy ^1.26.1
- open3d ^0.17.0
- plotly ^5.18.0
- python >=3.9,<3.13
- PyO3/maturin-action v1 composite
- actions/checkout v4 composite
- actions/download-artifact v3 composite
- actions/setup-python v4 composite
- actions/upload-artifact v3 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- dtolnay/rust-toolchain stable composite
- pdm-project/setup-pdm v3 composite
- peter-evans/create-pull-request v5 composite
- pre-commit-ci/lite-action v1.0.1 composite
- pre-commit/action v3.0.0 composite
- actions/checkout v4 composite
- dtolnay/rust-toolchain stable composite
- taiki-e/install-action v2 composite
- 134 dependencies
- actions/checkout v4 composite
- reviewdog/action-languagetool v1 composite