EGRET

pipeline coverage doc-coverage

Engine for Geometric Reflection and Edge diffraction Transfer

EGRET is a thin wrapper around PIGEON and PELICAN to provide a Python interface for the simulation of urban sound propagation in static scenarios. EGRET considers specular reflection and edge diffraction as well as air absorption, spreading loss and propagation delay.

This site contains the documentation for the EGRET package, including how to's, API documentation and examples.

Installation

EGRET is distributed through the IHTA Package Registry and can be installed using pip:

pip install egret --index-url https://git.rwth-aachen.de/api/v4/projects/109567/packages/pypi/simple

Note, that since EGRET is a wrapper around PIGEON and PELICAN, it only works on Windows, because PIGEON and PELICAN only work on Windows. Furthermore, due to the dependency on Blender the python version needs to be 3.11 exactly.

Running examples

Once EGRET is installed, the examples can be run by executing the following command in the terminal:

egret-examples