DiffeRT2d


NameDiffeRT2d JSON
Version 0.3.4 PyPI version JSON
download
home_pageNone
Summary2D Toolbox for Differentiable Ray Tracing
upload_time2024-06-30 17:36:34
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords differentiable ray tracing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # DiffeRT2d

[![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]

<img alt="DiffeRT2d Logo" align="right" width="512px" src="https://raw.githubusercontent.com/jeertmans/DiffeRT2d/main/static/logo_light_transparent.png">

Differentiable Ray Tracing Python Framework for Radio Propagation.

<!-- start description -->

DiffeRT2d is built on top of the
[JAX](https://github.com/google/jax)
library to provide a program that is *differentiable everywhere*.
With that, performing gradient-based optimization, or training
Machine Learning models with Ray Tracing (RT) becomes straightforward!
Moreover, the extensive use of the object-oriented paradigm
facilitates the simulation of complex objects, such as metasurfaces,
and the use of more advanced path tracing methods.

The objective of this tool is to provide a **simple-to-use** and
**highly interpretable** RT framework **for researchers** engaged
in fundamental studies of RT applied to radio propagation,
or any researcher interested in the various paths radio waves
can take in a given environment.

<!-- end description -->

> **IMPORTANT:**
> For 3D scenarios at city-scales,
> checkout [DiffeRT](https://github.com/jeertmans/DiffeRT).

- [Installation](#installation)
  * [Dependencies](#dependencies)
  * [Pip install](#pip-install)
  * [Install From Repository](#install-from-repository)
- [Usage](#usage)
- [Contributing](#contributing)
  * [Reporting an Issue](#reporting-an-issue)
  * [Seeking for Help](#seeking-for-help)
  * [Contact](#contact)

## Installation

<!-- start install -->

While installing DiffeRT2d and its dependencies on your global Python is fine,
we recommend using a virtual environment
(e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.

### Dependencies

<!-- start deps -->

DiffeRT2d uses [JAX](https://github.com/google/jax)
for automatic differentation,
which in turn may use (or not) CUDA for GPU acceleration.

If needed, please refer to
[JAX's installation guidelines](https://github.com/google/jax#installation)
for more details.

<!-- end deps -->

### Pip Install

The recommended way to install the latest release is to use pip:

```bash
pip install differt2d
```

### Install From Repository

An alternative way to install DiffeRT2d is to clone the git repository,
and install from there:
read the
[contributing guide](https://eertmans.be/DiffeRT2d/latest/contributing/workflow.html)
to know how.

<!-- end install -->

## Usage

For a quick introduction to DiffeRT2d, check you our
[Quickstart](https://eertmans.be/DiffeRT2d/latest/quickstart.html) tutorial!

You may find a multitude of usage examples across the documentation
or the [examples](https://github.com/jeertmans/DiffeRT2d/tree/main/examples)
folder, or directly in the
[examples gallery](https://eertmans.be/DiffeRT2d/latest/examples_gallery/index.html).

## Contributing

Contributions are more than welcome!
Please read through
[our contributing section](https://eertmans.be/DiffeRT2d/latest/contributing/index.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/DiffeRT2d/issues).
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/DiffeRT2d/issues/new).

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

<!-- end reporting-an-issue -->

### Seeking for help

<!-- start seeking-for-help -->

Sometimes, you may have a question about ,
not necessarily an issue.

There are two ways you can reach us for questions:

- via the
[GitHub issues](https://github.com/jeertmans/DiffeRT2d/issues);
- or via
[GitHub discussions](https://github.com/jeertmans/DiffeRT2d/discussions).

<!-- end seeking-for-help -->

### Contact

<!-- start contact -->

Finally, if you do not have any GitHub account,
or just wish to contact the author of DiffeRT2d,
you can do so at: [jeertmans@icloud.com](mailto:jeertmans@icloud.com).

<!-- end contact -->

[pypi-version-badge]: https://img.shields.io/pypi/v/DiffeRT2d?label=DiffeRT2d
[pypi-version-url]: https://pypi.org/project/DiffeRT2d/
[pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/DiffeRT2d
[documentation-badge]: https://img.shields.io/website?down_color=lightgrey&down_message=offline&label=documentation&up_color=green&up_message=online&url=https%3A%2F%2Feertmans.be%2FDiffeRT2d%2F
[documentation-url]: https://eertmans.be/DiffeRT2d/
[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.11386517.svg
[doi-url]: https://doi.org/10.5281/zenodo.11386517
[codecov-badge]: https://codecov.io/gh/jeertmans/DiffeRT2d/branch/main/graph/badge.svg?token=1dJ1AKWMR5
[codecov-url]: https://codecov.io/gh/jeertmans/DiffeRT2d

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "DiffeRT2d",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "differentiable, ray tracing",
    "author": null,
    "author_email": "J\u00e9rome Eertmans <jeertmans@icloud.com>",
    "download_url": "https://files.pythonhosted.org/packages/ff/21/a284e46adde69c60d0d06f0d92ac321eb51c8f5b9dcbc7d0fbc405e80c36/differt2d-0.3.4.tar.gz",
    "platform": null,
    "description": "# DiffeRT2d\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<img alt=\"DiffeRT2d Logo\" align=\"right\" width=\"512px\" src=\"https://raw.githubusercontent.com/jeertmans/DiffeRT2d/main/static/logo_light_transparent.png\">\n\nDifferentiable Ray Tracing Python Framework for Radio Propagation.\n\n<!-- start description -->\n\nDiffeRT2d is built on top of the\n[JAX](https://github.com/google/jax)\nlibrary to provide a program that is *differentiable everywhere*.\nWith that, performing gradient-based optimization, or training\nMachine Learning models with Ray Tracing (RT) becomes straightforward!\nMoreover, the extensive use of the object-oriented paradigm\nfacilitates the simulation of complex objects, such as metasurfaces,\nand the use of more advanced path tracing methods.\n\nThe objective of this tool is to provide a **simple-to-use** and\n**highly interpretable** RT framework **for researchers** engaged\nin fundamental studies of RT applied to radio propagation,\nor any researcher interested in the various paths radio waves\ncan take in a given environment.\n\n<!-- end description -->\n\n> **IMPORTANT:**\n> For 3D scenarios at city-scales,\n> checkout [DiffeRT](https://github.com/jeertmans/DiffeRT).\n\n- [Installation](#installation)\n  * [Dependencies](#dependencies)\n  * [Pip install](#pip-install)\n  * [Install From Repository](#install-from-repository)\n- [Usage](#usage)\n- [Contributing](#contributing)\n  * [Reporting an Issue](#reporting-an-issue)\n  * [Seeking for Help](#seeking-for-help)\n  * [Contact](#contact)\n\n## Installation\n\n<!-- start install -->\n\nWhile installing DiffeRT2d and its dependencies on your global Python is fine,\nwe recommend using a virtual environment\n(e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.\n\n### Dependencies\n\n<!-- start deps -->\n\nDiffeRT2d uses [JAX](https://github.com/google/jax)\nfor automatic differentation,\nwhich in turn may use (or not) CUDA for GPU acceleration.\n\nIf needed, please refer to\n[JAX's installation guidelines](https://github.com/google/jax#installation)\nfor more details.\n\n<!-- end deps -->\n\n### Pip Install\n\nThe recommended way to install the latest release is to use pip:\n\n```bash\npip install differt2d\n```\n\n### Install From Repository\n\nAn alternative way to install DiffeRT2d is to clone the git repository,\nand install from there:\nread the\n[contributing guide](https://eertmans.be/DiffeRT2d/latest/contributing/workflow.html)\nto know how.\n\n<!-- end install -->\n\n## Usage\n\nFor a quick introduction to DiffeRT2d, check you our\n[Quickstart](https://eertmans.be/DiffeRT2d/latest/quickstart.html) tutorial!\n\nYou may find a multitude of usage examples across the documentation\nor the [examples](https://github.com/jeertmans/DiffeRT2d/tree/main/examples)\nfolder, or directly in the\n[examples gallery](https://eertmans.be/DiffeRT2d/latest/examples_gallery/index.html).\n\n## Contributing\n\nContributions are more than welcome!\nPlease read through\n[our contributing section](https://eertmans.be/DiffeRT2d/latest/contributing/index.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/DiffeRT2d/issues).\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/DiffeRT2d/issues/new).\n\nThe more precise you are in the description of your problem, the faster we will\nbe able to help you!\n\n<!-- end reporting-an-issue -->\n\n### Seeking for help\n\n<!-- start seeking-for-help -->\n\nSometimes, you may have a question about ,\nnot necessarily an issue.\n\nThere are two ways you can reach us for questions:\n\n- via the\n[GitHub issues](https://github.com/jeertmans/DiffeRT2d/issues);\n- or via\n[GitHub discussions](https://github.com/jeertmans/DiffeRT2d/discussions).\n\n<!-- end seeking-for-help -->\n\n### Contact\n\n<!-- start contact -->\n\nFinally, if you do not have any GitHub account,\nor just wish to contact the author of DiffeRT2d,\nyou can do so at: [jeertmans@icloud.com](mailto:jeertmans@icloud.com).\n\n<!-- end contact -->\n\n[pypi-version-badge]: https://img.shields.io/pypi/v/DiffeRT2d?label=DiffeRT2d\n[pypi-version-url]: https://pypi.org/project/DiffeRT2d/\n[pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/DiffeRT2d\n[documentation-badge]: https://img.shields.io/website?down_color=lightgrey&down_message=offline&label=documentation&up_color=green&up_message=online&url=https%3A%2F%2Feertmans.be%2FDiffeRT2d%2F\n[documentation-url]: https://eertmans.be/DiffeRT2d/\n[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.11386517.svg\n[doi-url]: https://doi.org/10.5281/zenodo.11386517\n[codecov-badge]: https://codecov.io/gh/jeertmans/DiffeRT2d/branch/main/graph/badge.svg?token=1dJ1AKWMR5\n[codecov-url]: https://codecov.io/gh/jeertmans/DiffeRT2d\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "2D Toolbox for Differentiable Ray Tracing",
    "version": "0.3.4",
    "project_urls": {
        "Changelog": "https://github.com/jeertmans/DiffeRT2d/releases",
        "Documentation": "https://eertmans.be/DiffeRT2d",
        "Founding": "https://github.com/sponsors/jeertmans",
        "Homepage": "https://github.com/jeertmans/DiffeRT2d",
        "Repository": "https://github.com/jeertmans/DiffeRT2d"
    },
    "split_keywords": [
        "differentiable",
        " ray tracing"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ddbb3cd18f6131ed61c97878239732f2481ff97c667e78bfcfd303dc4628d319",
                "md5": "6a49d98318e96a5ca1b650cb9469f6fe",
                "sha256": "12fd0b94677b3956ebe442b920eb0aabc5c3783a6b35e85e89f36cc96278c2dd"
            },
            "downloads": -1,
            "filename": "differt2d-0.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6a49d98318e96a5ca1b650cb9469f6fe",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 31852,
            "upload_time": "2024-06-30T17:36:31",
            "upload_time_iso_8601": "2024-06-30T17:36:31.622888Z",
            "url": "https://files.pythonhosted.org/packages/dd/bb/3cd18f6131ed61c97878239732f2481ff97c667e78bfcfd303dc4628d319/differt2d-0.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ff21a284e46adde69c60d0d06f0d92ac321eb51c8f5b9dcbc7d0fbc405e80c36",
                "md5": "442abaff213a4ff486b738f52a36f9ae",
                "sha256": "9ecbb594fb0882d22a729499c3c89d1d03abc7592ba4005d9920e4972a6f2965"
            },
            "downloads": -1,
            "filename": "differt2d-0.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "442abaff213a4ff486b738f52a36f9ae",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 30493377,
            "upload_time": "2024-06-30T17:36:34",
            "upload_time_iso_8601": "2024-06-30T17:36:34.195557Z",
            "url": "https://files.pythonhosted.org/packages/ff/21/a284e46adde69c60d0d06f0d92ac321eb51c8f5b9dcbc7d0fbc405e80c36/differt2d-0.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-30 17:36:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jeertmans",
    "github_project": "DiffeRT2d",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "differt2d"
}
None
Elapsed time: 6.05468s