differt.scene.download_sionna_scenes

differt.scene.download_sionna_scenes#

download_sionna_scenes(branch_or_tag='main', repo='NVlabs/sionna-rt', scenes_folder='src/sionna/rt/scenes/', *, folder='<path-to-differt>/scene/scenes', cached=True, chunk_size=1024, progress=True, leave=False, timeout=None)[source]#

Download the scenes from Sionna, and store them in the given folder.

If cached is False and folder exists, then it will raise an error if not empty: please clear it first!

Warning

Older Python versions (i.e., <3.12, <3.11.4, and <3.10.12) do not provide the filter parameter in tarfile.TarFile.extractall, which can be considered a security risk. This function will raise a warning if the current Python version is one of these versions.

Parameters:

  • branch_or_tag (str) – The branch or tag version of the Sionna repository.

  • repo (str) –

    The repository {owner}/{name} on GitHub from which to download the scenes.

    E.g., you can change this if you want to use a fork instead.

  • scenes_folder (str) – The folder where the scenes are stored in the repository.

  • folder (str | Path) – Where to extract the scene files, i.e., the content of sionna/rt/scenes/.

  • cached (bool) – Whether to avoid downloading again if the target folder already exists.

  • chunk_size (int) – The chunk size, in bytes, used when downloading the data.

  • progress (bool) – Whether to output a progress bar when downloading.

  • leave (bool) – If progress is True, whether to leave the progress bar upon completion.

  • timeout (float | tuple[float, float] | None) – How many seconds to wait before giving up on the download, see requests.request.

Return type:

None

Contents