<div align="center">
<img src="https://raw.githubusercontent.com/jeertmans/DiffeRT/main/static/logo_250px.png" alt="DiffeRT logo"></img>
</div>
<div align="center">
# 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]
</div>
## Usage
> **WARNING:**
> Until this package reaches version `v0.1.0`, breaking changes
> should be expected.
> Checkout the [v0.1.0](https://github.com/jeertmans/DiffeRT/milestone/1)
> and [v1.0.0](https://github.com/jeertmans/DiffeRT/milestone/2) milestones 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,
or want to customize the installation (e.g., with GPU support), check out the
[installation guide](https://differt.readthedocs.io/latest/installation.html).
### Reporting an issue
<!-- start 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](https://github.com/jeertmans/DiffeRT/issues?q=is%3Aissue).
If your problem is not covered by an already existing (closed or open) issue,
then we suggest you create a
[new issue](https://github.com/jeertmans/DiffeRT/issues/new/choose).
You can choose from a list of templates, or open a
[blank issue](https://github.com/jeertmans/DiffeRT/issues/new)
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 question than a problem,
then it is probably best suited to ask it in the
[Q&A category of the discussions](https://github.com/jeertmans/DiffeRT/discussions/categories/q-a).
<!-- end reporting-an-issue -->
## Contributing
All types of contributions are more than welcome!
Please follow the
[contributing guide](https://differt.readthedocs.io/latest/contributing.html)
for a detailed step-by-step procedure.
## Citing
If you use this software, please cite it as
[detailed here](https://differt.readthedocs.io/latest/citing.html).
[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.13895021.svg
[doi-url]: https://doi.org/10.5281/zenodo.13895021
[codecov-badge]: https://codecov.io/gh/jeertmans/DiffeRT/branch/main/graph/badge.svg?token=v63alnTWzu
[codecov-url]: https://codecov.io/gh/jeertmans/DiffeRT
Raw data
{
"_id": null,
"home_page": null,
"name": "DiffeRT",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "differentiable, jax, propagation, radio, ray tracing",
"author": null,
"author_email": "J\u00e9rome Eertmans <jeertmans@icloud.com>",
"download_url": "https://files.pythonhosted.org/packages/4f/96/4daddf0ec416df08df4c4a7f25f1d7eac24044609c7659476bd668f97ac3/differt-0.0.30.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n<img src=\"https://raw.githubusercontent.com/jeertmans/DiffeRT/main/static/logo_250px.png\" alt=\"DiffeRT logo\"></img>\n</div>\n\n<div align=\"center\">\n\n# DiffeRT\n\n[![Latest Release][pypi-version-badge]][pypi-version-url]\n[![Python version][pypi-python-version-badge]][pypi-version-url]\n[![Documentation][documentation-badge]][documentation-url]\n[![DOI][doi-badge]][doi-url]\n[![Codecov][codecov-badge]][codecov-url]\n\n</div>\n\n## Usage\n\n> **WARNING:**\n> Until this package reaches version `v0.1.0`, breaking changes\n> should be expected.\n> Checkout the [v0.1.0](https://github.com/jeertmans/DiffeRT/milestone/1)\n> and [v1.0.0](https://github.com/jeertmans/DiffeRT/milestone/2) milestones for future\n> features.\n>\n> If you have any suggestion regarding the development of this package,\n> please open an [issue](https://github.com/jeertmans/DiffeRT/issues).\n\nThe easiest way to install DiffeRT is through pip:\n\n```bash\npip install differt\n```\n\nWe provide pre-built binaries for most platforms. If you want (or need)\nto build the package from the source distribution,\nor want to customize the installation (e.g., with GPU support), check out the\n[installation guide](https://differt.readthedocs.io/latest/installation.html).\n\n### Reporting an issue\n\n<!-- start reporting-an-issue -->\n\nIf you think you found a bug,\nan error in the documentation,\nor wish there was some feature that is currently missing,\nwe would love to hear from you!\n\nThe best way to reach us is via the\n[GitHub issues](https://github.com/jeertmans/DiffeRT/issues?q=is%3Aissue).\nIf your problem is not covered by an already existing (closed or open) issue,\nthen we suggest you create a\n[new issue](https://github.com/jeertmans/DiffeRT/issues/new/choose).\nYou can choose from a list of templates, or open a\n[blank issue](https://github.com/jeertmans/DiffeRT/issues/new)\nif your issue does not fit one of the proposed topics.\n\nThe more precise you are in the description of your problem, the faster we will\nbe able to help you!\n\nIf you rather have question than a problem,\nthen it is probably best suited to ask it in the\n[Q&A category of the discussions](https://github.com/jeertmans/DiffeRT/discussions/categories/q-a).\n\n<!-- end reporting-an-issue -->\n\n## Contributing\n\nAll types of contributions are more than welcome!\n\nPlease follow the\n[contributing guide](https://differt.readthedocs.io/latest/contributing.html)\nfor a detailed step-by-step procedure.\n\n## Citing\n\nIf you use this software, please cite it as\n[detailed here](https://differt.readthedocs.io/latest/citing.html).\n\n[pypi-version-badge]: https://img.shields.io/pypi/v/DiffeRT?label=DiffeRT&color=blueviolet\n[pypi-version-url]: https://pypi.org/project/DiffeRT/\n[pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/DiffeRT?color=orange\n[documentation-badge]: https://readthedocs.org/projects/differt/badge/?version=latest\n[documentation-url]: https://differt.readthedocs.io/latest/?badge=latest\n[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.13895021.svg\n[doi-url]: https://doi.org/10.5281/zenodo.13895021\n[codecov-badge]: https://codecov.io/gh/jeertmans/DiffeRT/branch/main/graph/badge.svg?token=v63alnTWzu\n[codecov-url]: https://codecov.io/gh/jeertmans/DiffeRT\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Differentiable Ray Tracing Toolbox for Radio Propagation Simulations",
"version": "0.0.30",
"project_urls": {
"Changelog": "https://github.com/jeertmans/DiffeRT/releases",
"Documentation": "https://eertmans.be/DiffeRT",
"Founding": "https://github.com/sponsors/jeertmans",
"Homepage": "https://github.com/jeertmans/DiffeRT",
"Repository": "https://github.com/jeertmans/DiffeRT"
},
"split_keywords": [
"differentiable",
" jax",
" propagation",
" radio",
" ray tracing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "39ffb330746e0f61ba588de3335adce080306e5d0838c6dbb55ea6d557437cc6",
"md5": "b2007ddb74729140bebde85f422771ac",
"sha256": "886763e183b5a86e260af12ab56a1f19e506ff34e99bcb8423e4964c3b9792ab"
},
"downloads": -1,
"filename": "differt-0.0.30-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b2007ddb74729140bebde85f422771ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 61414,
"upload_time": "2024-12-13T17:25:18",
"upload_time_iso_8601": "2024-12-13T17:25:18.537317Z",
"url": "https://files.pythonhosted.org/packages/39/ff/b330746e0f61ba588de3335adce080306e5d0838c6dbb55ea6d557437cc6/differt-0.0.30-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f964daddf0ec416df08df4c4a7f25f1d7eac24044609c7659476bd668f97ac3",
"md5": "d167fb23df9a51030c302c453bc9ac14",
"sha256": "e8da2cb98afe7e6613598f9a96a56cabaaf2a925e8d458a938e1b9e63423bf56"
},
"downloads": -1,
"filename": "differt-0.0.30.tar.gz",
"has_sig": false,
"md5_digest": "d167fb23df9a51030c302c453bc9ac14",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 51714,
"upload_time": "2024-12-13T17:25:21",
"upload_time_iso_8601": "2024-12-13T17:25:21.316524Z",
"url": "https://files.pythonhosted.org/packages/4f/96/4daddf0ec416df08df4c4a7f25f1d7eac24044609c7659476bd668f97ac3/differt-0.0.30.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-13 17:25:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jeertmans",
"github_project": "DiffeRT",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "differt"
}
JSON
