Getting started#

This guide shows one end-to-end MIRACLE retrieval through both public entry points.

Installation summary#

Install irdl into an environment first. For the full set of installation paths, see Installation.

$ uv pip install irdl

Python#

Use the MIRACLE Dataset class directly:

from irdl import MiracleDataset

data = MiracleDataset.get(scenario="D1")

print(data["impulse_response"])
print(data["source_coordinates"])
print(data["receiver_coordinates"])

By default, get() returns in-memory pyfar objects. Use output_format when you want NumPy arrays or a file-backed return such as "sofa" or "hdf5".

CLI#

The CLI exposes the same MIRACLE retrieval flow as a Dataset subcommand:

$ irdl miracle --scenario D1

Add --output-format sofa or --output-format hdf5 when you want a file-backed result. Use --export-dir to copy the requested artifact to an Export Directory.

Next steps#