torchrir 0.1.0__py3-none-any.whl → 0.1.4__py3-none-any.whl

torchrir/scene_utils.py

@@ -15,7 +15,13 @@ def sample_positions(
     rng: random.Random,
     margin: float = 0.5,
 ) -> torch.Tensor:
-    """Sample random positions within a room with a safety margin."""
+    """Sample random positions within a room with a safety margin.
+
+    Example:
+        >>> rng = random.Random(0)
+        >>> room = torch.tensor([6.0, 4.0, 3.0])
+        >>> positions = sample_positions(num=2, room_size=room, rng=rng)
+    """
     dim = room_size.numel()
     low = [margin] * dim
     high = [float(room_size[i].item()) - margin for i in range(dim)]
@@ -26,8 +32,14 @@ def sample_positions(
     return torch.tensor(coords, dtype=torch.float32)
 
 
-def linear_trajectory(start: torch.Tensor, end: torch.Tensor, steps: int) -> torch.Tensor:
-    """Create a linear trajectory between start and end."""
+def linear_trajectory(
+    start: torch.Tensor, end: torch.Tensor, steps: int
+) -> torch.Tensor:
+    """Create a linear trajectory between start and end.
+
+    Example:
+        >>> traj = linear_trajectory(torch.tensor([1.0, 1.0, 1.0]), torch.tensor([4.0, 2.0, 1.0]), 8)
+    """
     return torch.stack(
         [start + (end - start) * t / (steps - 1) for t in range(steps)],
         dim=0,
@@ -35,7 +47,11 @@ def linear_trajectory(start: torch.Tensor, end: torch.Tensor, steps: int) -> tor
 
 
 def binaural_mic_positions(center: torch.Tensor, offset: float = 0.08) -> torch.Tensor:
-    """Create a two-mic binaural layout around a center point."""
+    """Create a two-mic binaural layout around a center point.
+
+    Example:
+        >>> mics = binaural_mic_positions(torch.tensor([2.0, 2.0, 1.5]))
+    """
     dim = center.numel()
     offset_vec = torch.zeros((dim,), dtype=torch.float32)
     offset_vec[0] = offset
@@ -44,8 +60,14 @@ def binaural_mic_positions(center: torch.Tensor, offset: float = 0.08) -> torch.
     return torch.stack([left, right], dim=0)
 
 
-def clamp_positions(positions: torch.Tensor, room_size: torch.Tensor, margin: float = 0.1) -> torch.Tensor:
-    """Clamp positions to remain inside the room with a margin."""
+def clamp_positions(
+    positions: torch.Tensor, room_size: torch.Tensor, margin: float = 0.1
+) -> torch.Tensor:
+    """Clamp positions to remain inside the room with a margin.
+
+    Example:
+        >>> clamped = clamp_positions(positions, torch.tensor([6.0, 4.0, 3.0]))
+    """
     min_v = torch.full_like(room_size, margin)
     max_v = room_size - margin
     return torch.max(torch.min(positions, max_v), min_v)

torchrir/signal.py

@@ -21,6 +21,9 @@ def fft_convolve(signal: Tensor, rir: Tensor) -> Tensor:
 
     Returns:
         1D tensor of length len(signal) + len(rir) - 1.
+
+    Example:
+        >>> y = fft_convolve(signal, rir)
     """
     if signal.ndim != 1 or rir.ndim != 1:
         raise ValueError("fft_convolve expects 1D tensors")
@@ -41,6 +44,9 @@ def convolve_rir(signal: Tensor, rirs: Tensor) -> Tensor:
 
     Returns:
         (n_mic, n_samples + rir_len - 1) tensor or 1D for single mic.
+
+    Example:
+        >>> y = convolve_rir(signal, rirs)
     """
     signal = _ensure_signal(signal)
     rirs = _ensure_static_rirs(rirs)
@@ -111,9 +117,9 @@ def _convolve_dynamic_rir_trajectory(
     else:
         step_fs = n_samples / t_steps
         ts_dtype = torch.float32 if signal.device.type == "mps" else torch.float64
-        w_ini = (torch.arange(t_steps, device=signal.device, dtype=ts_dtype) * step_fs).to(
-            torch.long
-        )
+        w_ini = (
+            torch.arange(t_steps, device=signal.device, dtype=ts_dtype) * step_fs
+        ).to(torch.long)
 
     w_ini = torch.cat(
         [w_ini, torch.tensor([n_samples], device=signal.device, dtype=torch.long)]
@@ -126,14 +132,18 @@ def _convolve_dynamic_rir_trajectory(
         )
 
     max_len = int(w_len.max().item())
-    segments = torch.zeros((t_steps, n_src, max_len), dtype=signal.dtype, device=signal.device)
+    segments = torch.zeros(
+        (t_steps, n_src, max_len), dtype=signal.dtype, device=signal.device
+    )
     for t in range(t_steps):
         start = int(w_ini[t].item())
         end = int(w_ini[t + 1].item())
         if end > start:
             segments[t, :, : end - start] = signal[:, start:end]
 
-    out = torch.zeros((n_mic, n_samples + rir_len - 1), dtype=signal.dtype, device=signal.device)
+    out = torch.zeros(
+        (n_mic, n_samples + rir_len - 1), dtype=signal.dtype, device=signal.device
+    )
 
     for t in range(t_steps):
         seg_len = int(w_len[t].item())
@@ -160,7 +170,9 @@ def _convolve_dynamic_rir_trajectory_batched(
     """GPU-friendly batched trajectory convolution using FFT."""
     n_samples = signal.shape[1]
     t_steps, n_src, n_mic, rir_len = rirs.shape
-    out = torch.zeros((n_mic, n_samples + rir_len - 1), dtype=signal.dtype, device=signal.device)
+    out = torch.zeros(
+        (n_mic, n_samples + rir_len - 1), dtype=signal.dtype, device=signal.device
+    )
 
     for t0 in range(0, t_steps, chunk_size):
         t1 = min(t0 + chunk_size, t_steps)
@@ -168,7 +180,9 @@ def _convolve_dynamic_rir_trajectory_batched(
         max_len = int(lengths.max().item())
         if max_len == 0:
             continue
-        segments = torch.zeros((t1 - t0, n_src, max_len), dtype=signal.dtype, device=signal.device)
+        segments = torch.zeros(
+            (t1 - t0, n_src, max_len), dtype=signal.dtype, device=signal.device
+        )
         for idx, t in enumerate(range(t0, t1)):
             start = int(w_ini[t].item())
             end = int(w_ini[t + 1].item())
@@ -184,7 +198,9 @@ def _convolve_dynamic_rir_trajectory_batched(
             dtype=signal.dtype,
             device=signal.device,
         )
-        conv = torch.fft.irfft(seg_f[:, :, None, :] * rir_f, n=fft_len, dim=-1, out=conv_out)
+        conv = torch.fft.irfft(
+            seg_f[:, :, None, :] * rir_f, n=fft_len, dim=-1, out=conv_out
+        )
         conv = conv[..., :conv_len]
         conv_sum = conv.sum(dim=1)
 
@@ -193,7 +209,9 @@ def _convolve_dynamic_rir_trajectory_batched(
             if seg_len == 0:
                 continue
             start = int(w_ini[t].item())
-            out[:, start : start + seg_len + rir_len - 1] += conv_sum[idx, :, : seg_len + rir_len - 1]
+            out[:, start : start + seg_len + rir_len - 1] += conv_sum[
+                idx, :, : seg_len + rir_len - 1
+            ]
 
     return out.squeeze(0) if n_mic == 1 else out
 
@@ -215,7 +233,9 @@ def _ensure_static_rirs(rirs: Tensor) -> Tensor:
         return rirs.view(1, rirs.shape[0], rirs.shape[1])
     if rirs.ndim == 3:
         return rirs
-    raise ValueError("rirs must have shape (rir_len,), (n_mic, rir_len), or (n_src, n_mic, rir_len)")
+    raise ValueError(
+        "rirs must have shape (rir_len,), (n_mic, rir_len), or (n_src, n_mic, rir_len)"
+    )
 
 
 def _ensure_dynamic_rirs(rirs: Tensor, signal: Tensor) -> Tensor:

torchrir/simulators.py

@@ -18,15 +18,23 @@ from .scene import Scene
 class RIRSimulator(Protocol):
     """Strategy interface for RIR simulation backends."""
 
-    def simulate(self, scene: Scene, config: SimulationConfig | None = None) -> RIRResult:
+    def simulate(
+        self, scene: Scene, config: SimulationConfig | None = None
+    ) -> RIRResult:
         """Run a simulation and return the result."""
 
 
 @dataclass(frozen=True)
 class ISMSimulator:
-    """ISM-based simulator using the current core implementation."""
+    """ISM-based simulator using the current core implementation.
 
-    def simulate(self, scene: Scene, config: SimulationConfig | None = None) -> RIRResult:
+    Example:
+        >>> result = ISMSimulator().simulate(scene, config)
+    """
+
+    def simulate(
+        self, scene: Scene, config: SimulationConfig | None = None
+    ) -> RIRResult:
         scene.validate()
         cfg = config or default_config()
         if scene.is_dynamic():
@@ -67,7 +75,9 @@ class RayTracingSimulator:
         reuse Scene/SimulationConfig for inputs and keep output shape parity.
     """
 
-    def simulate(self, scene: Scene, config: SimulationConfig | None = None) -> RIRResult:
+    def simulate(
+        self, scene: Scene, config: SimulationConfig | None = None
+    ) -> RIRResult:
         raise NotImplementedError("RayTracingSimulator is not implemented yet")
 
 
@@ -82,5 +92,7 @@ class FDTDSimulator:
         RIRResult with the same metadata contract as ISM.
     """
 
-    def simulate(self, scene: Scene, config: SimulationConfig | None = None) -> RIRResult:
+    def simulate(
+        self, scene: Scene, config: SimulationConfig | None = None
+    ) -> RIRResult:
         raise NotImplementedError("FDTDSimulator is not implemented yet")

torchrir/utils.py

@@ -15,7 +15,7 @@ _DEF_SPEED_OF_SOUND = 343.0
 
 
 def as_tensor(
-    value: Tensor | Iterable[float] | float | int,
+    value: Tensor | Iterable[float] | Iterable[Iterable[float]] | float | int,
     *,
     device: Optional[torch.device | str] = None,
     dtype: Optional[torch.dtype] = None,
@@ -41,6 +41,9 @@ def resolve_device(
     """Resolve a device string (including 'auto') into a torch.device.
 
     Falls back to CPU when the requested backend is unavailable.
+
+    Example:
+        >>> device = resolve_device("auto")
     """
     if device is None:
         return torch.device("cpu")
@@ -76,7 +79,12 @@ def resolve_device(
 
 @dataclass(frozen=True)
 class DeviceSpec:
-    """Resolve device + dtype defaults consistently."""
+    """Resolve device + dtype defaults consistently.
+
+    Example:
+        >>> spec = DeviceSpec(device="auto", dtype=torch.float32)
+        >>> device, dtype = spec.resolve(tensor)
+    """
 
     device: Optional[torch.device | str] = None
     dtype: Optional[torch.dtype] = None
@@ -140,7 +148,11 @@ def estimate_beta_from_t60(
     device: Optional[torch.device | str] = None,
     dtype: Optional[torch.dtype] = None,
 ) -> Tensor:
-    """Estimate reflection coefficients from T60 using Sabine's formula."""
+    """Estimate reflection coefficients from T60 using Sabine's formula.
+
+    Example:
+        >>> beta = estimate_beta_from_t60(torch.tensor([6.0, 4.0, 3.0]), t60=0.4)
+    """
     if t60 <= 0:
         raise ValueError("t60 must be positive")
     size = as_tensor(size, device=device, dtype=dtype)
@@ -172,7 +184,11 @@ def estimate_t60_from_beta(
     device: Optional[torch.device | str] = None,
     dtype: Optional[torch.dtype] = None,
 ) -> float:
-    """Estimate T60 from reflection coefficients using Sabine's formula."""
+    """Estimate T60 from reflection coefficients using Sabine's formula.
+
+    Example:
+        >>> t60 = estimate_t60_from_beta(torch.tensor([6.0, 4.0, 3.0]), beta=torch.full((6,), 0.9))
+    """
     size = as_tensor(size, device=device, dtype=dtype)
     size = ensure_dim(size)
     beta = as_tensor(beta, device=size.device, dtype=size.dtype)
@@ -244,7 +260,11 @@ def orientation_to_unit(orientation: Tensor, dim: int) -> Tensor:
 
 
 def att2t_sabine_estimation(att_db: float, t60: float) -> float:
-    """Convert attenuation (dB) to time based on T60."""
+    """Convert attenuation (dB) to time based on T60.
+
+    Example:
+        >>> t = att2t_sabine_estimation(att_db=60.0, t60=0.4)
+    """
     if t60 <= 0:
         raise ValueError("t60 must be positive")
     if att_db <= 0:
@@ -253,17 +273,29 @@ def att2t_sabine_estimation(att_db: float, t60: float) -> float:
 
 
 def att2t_SabineEstimation(att_db: float, t60: float) -> float:
-    """Legacy alias for att2t_sabine_estimation."""
+    """Legacy alias for att2t_sabine_estimation.
+
+    Example:
+        >>> t = att2t_SabineEstimation(att_db=60.0, t60=0.4)
+    """
     return att2t_sabine_estimation(att_db, t60)
 
 
 def beta_SabineEstimation(room_size: Tensor, t60: float) -> Tensor:
-    """Legacy alias for estimate_beta_from_t60."""
+    """Legacy alias for estimate_beta_from_t60.
+
+    Example:
+        >>> beta = beta_SabineEstimation(torch.tensor([6.0, 4.0, 3.0]), t60=0.4)
+    """
     return estimate_beta_from_t60(room_size, t60)
 
 
 def t2n(tmax: float, room_size: Tensor, c: float = _DEF_SPEED_OF_SOUND) -> Tensor:
-    """Estimate image counts per dimension needed to cover tmax."""
+    """Estimate image counts per dimension needed to cover tmax.
+
+    Example:
+        >>> nb_img = t2n(0.3, torch.tensor([6.0, 4.0, 3.0]))
+    """
     if tmax <= 0:
         raise ValueError("tmax must be positive")
     size = as_tensor(room_size)

torchrir-0.1.4.dist-info/METADATA

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: torchrir
+Version: 0.1.4
+Summary: PyTorch-based room impulse response (RIR) simulation toolkit for static and dynamic scenes.
+Project-URL: Repository, https://github.com/taishi-n/torchrir
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy>=2.2.6
+Requires-Dist: torch>=2.10.0
+Dynamic: license-file
+
+# TorchRIR
+
+PyTorch-based room impulse response (RIR) simulation toolkit focused on a clean, modern API with GPU support.
+This project has been substantially assisted by AI using Codex.
+
+## Installation
+```bash
+pip install torchrir
+```
+
+## Examples
+- `examples/static.py`: fixed sources/mics with binaural output.  
+  `uv run python examples/static.py --plot`
+- `examples/dynamic_src.py`: moving sources, fixed mics.  
+  `uv run python examples/dynamic_src.py --plot`
+- `examples/dynamic_mic.py`: fixed sources, moving mics.  
+  `uv run python examples/dynamic_mic.py --plot`
+- `examples/cli.py`: unified CLI for static/dynamic scenes, JSON/YAML configs.  
+  `uv run python examples/cli.py --mode static --plot`
+- `examples/cmu_arctic_dynamic_dataset.py`: small dynamic dataset generator (fixed room/mics, randomized source motion).  
+  `uv run python examples/cmu_arctic_dynamic_dataset.py --num-scenes 4 --num-sources 2`
+- `examples/benchmark_device.py`: CPU/GPU benchmark for RIR simulation.  
+  `uv run python examples/benchmark_device.py --dynamic`
+
+## Core API Overview
+- Geometry: `Room`, `Source`, `MicrophoneArray`
+- Static RIR: `simulate_rir`
+- Dynamic RIR: `simulate_dynamic_rir`
+- Dynamic convolution: `DynamicConvolver`
+- Metadata export: `build_metadata`, `save_metadata_json`
+
+```python
+from torchrir import DynamicConvolver, MicrophoneArray, Room, Source, simulate_rir
+
+room = Room.shoebox(size=[6.0, 4.0, 3.0], fs=16000, beta=[0.9] * 6)
+sources = Source.from_positions([[1.0, 2.0, 1.5]])
+mics = MicrophoneArray.from_positions([[2.0, 2.0, 1.5]])
+
+rir = simulate_rir(room=room, sources=sources, mics=mics, max_order=6, tmax=0.3)
+# For dynamic scenes, compute rirs with simulate_dynamic_rir and convolve:
+# y = DynamicConvolver(mode="trajectory").convolve(signal, rirs)
+```
+
+For detailed documentation, see the docs under `docs/` and Read the Docs.
+
+## Future Work
+- Ray tracing backend: implement `RayTracingSimulator` with frequency-dependent absorption/scattering.
+- CUDA-native acceleration: introduce dedicated CUDA kernels for large-scale RIR generation.
+- Dataset expansion: add additional dataset integrations beyond CMU ARCTIC (see `TemplateDataset`).
+- Add regression tests comparing generated RIRs against gpuRIR outputs.
+
+## Related Libraries
+- [gpuRIR](https://github.com/DavidDiazGuerra/gpuRIR)
+- [Cross3D](https://github.com/DavidDiazGuerra/Cross3D)
+- [pyroomacoustics](https://github.com/LCAV/pyroomacoustics)
+- [das-generator](https://github.com/ehabets/das-generator)
+- [rir-generator](https://github.com/audiolabs/rir-generator)

torchrir-0.1.4.dist-info/RECORD

@@ -0,0 +1,28 @@
+torchrir/__init__.py,sha256=urydbUWuUHPBqmy-9QBaQg8eFGznRamkSjLmPiNvBo0,2383
+torchrir/animation.py,sha256=x3Y-BLz3J6DQNmoDIjbMEgGfng2yavJFLyQEmRCSpQU,6391
+torchrir/config.py,sha256=PsZdDIS3p4jepeNSHyd69aSD9QlOEdpG9v1SAXlZ_Fg,2295
+torchrir/core.py,sha256=VdljYoCoQoZqD8aYJRnuHEb7uORQjyQysVc8K3RGuao,26826
+torchrir/directivity.py,sha256=v_t37YgeXF_IYzbnrk0TCs1npb_0yKR7zHiG8XV3V4w,1259
+torchrir/dynamic.py,sha256=01JHMxhORdcz93J-YaMIeSLo7k2tHrZke8llPHHXwZg,2153
+torchrir/logging_utils.py,sha256=s4jDSSDoHT0HKeplDUpGMsdeBij4eibLSpaaAPzkB68,2146
+torchrir/metadata.py,sha256=cwoXrr_yE2bQRUPnJe6p7POMPCWa9_oabCtp--WqBE8,6958
+torchrir/plotting.py,sha256=TM1LxPitZq5KXdNe1GfUCOnzFOzerGhWIFblzIz142A,8170
+torchrir/plotting_utils.py,sha256=Kg3TCLqEq_lxVQkYHI6vyz_6oG3Ic_Z8H9gZN-39QeI,5180
+torchrir/results.py,sha256=-HczEfr2u91BNb1xbrIGKCj0G3yzy7l_fmUMUeKbGRw,614
+torchrir/room.py,sha256=zFnEzw0Rr1NP9IUc3iNTInyoq6t3X-0yOyUtDnsLSPk,4325
+torchrir/scene.py,sha256=GuHuCspakAUOT81_ArTqaZbmBX0ApoJuCKTaZ21wGis,2435
+torchrir/scene_utils.py,sha256=2La5dtjxYdINX315VXRRJMJK9oaR2rY0xHmDLjZma8M,2140
+torchrir/signal.py,sha256=M0BpKDBqrfOmCHIJ_dvl-C3uKdFpXLDqtSIU115jsME,8383
+torchrir/simulators.py,sha256=NCl8Ptv2TGdBpNLwAb3nigT77On-BLIANtc2ivgKasw,3131
+torchrir/utils.py,sha256=2oE-JzAtkW5qdRds2Y5R5lbSyNZl_9piFXd6xOLzjxM,10680
+torchrir/datasets/__init__.py,sha256=3T55F3fjjRR3j618ubRkMlZnQTxvXaxioFMhygxm7oQ,601
+torchrir/datasets/base.py,sha256=mCHLtGOOaD1II1alJpP6ipzkz87l-rh19NgfeLnJbDU,720
+torchrir/datasets/cmu_arctic.py,sha256=DrOcawHvOEUnFJRw4qZgwuK1jbL2oQ-Vz_zNodYtpjE,7049
+torchrir/datasets/template.py,sha256=pHAKj5E7Gehfk9pqdTsFQjiDV1OK3hSZJIbYutd-E4c,2090
+torchrir/datasets/utils.py,sha256=TUfdt_XSB71ztCfzq_gCNrbvPh0Y-O5gkyxUnHWYID0,3227
+torchrir-0.1.4.dist-info/licenses/LICENSE,sha256=5vS_7WTsMEw_QQHEPQ_WCwovJXEgmxoEwcwOI-9VbXI,10766
+torchrir-0.1.4.dist-info/licenses/NOTICE,sha256=SRs_q-ZqoVF9_YuuedZOvVBk01jV7YQAeF8rRvlRg0s,118
+torchrir-0.1.4.dist-info/METADATA,sha256=HNSQV3uXeRYfX9eDb7ZllGAMvWCdtzq9Rn-q0kokkL4,2964
+torchrir-0.1.4.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+torchrir-0.1.4.dist-info/top_level.txt,sha256=aIFwntowJjvm7rZk480HymC3ipDo1g-9hEbNY1wF-Oo,9
+torchrir-0.1.4.dist-info/RECORD,,

torchrir-0.1.0.dist-info/METADATA

@@ -1,213 +0,0 @@
-Metadata-Version: 2.4
-Name: torchrir
-Version: 0.1.0
-Summary: Add your description here
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-License-File: NOTICE
-Requires-Dist: numpy>=2.2.6
-Requires-Dist: torch>=2.10.0
-Dynamic: license-file
-
-# TorchRIR
-
-PyTorch-based room impulse response (RIR) simulation toolkit focused on a clean, modern API with GPU support.
-This project has been substantially assisted by AI using Codex.
-
-## License
-Apache-2.0. See `LICENSE` and `NOTICE`.
-
-## Example Usage
-```bash
-# CMU ARCTIC + static RIR (fixed sources/mics)
-uv run python examples/static.py --plot
-
-# Dynamic RIR demos
-uv run python examples/dynamic_mic.py --plot
-uv run python examples/dynamic_src.py --plot
-
-# Unified CLI
-uv run python examples/cli.py --mode static --plot
-uv run python examples/cli.py --mode dynamic_mic --plot
-uv run python examples/cli.py --mode dynamic_src --plot
-
-# Config + deterministic
-uv run python examples/cli.py --mode static --deterministic --seed 123 --config-out outputs/cli.json
-uv run python examples/cli.py --config-in outputs/cli.json
-```
-YAML configs are supported when `PyYAML` is installed.
-```bash
-# YAML config
-uv run python examples/cli.py --mode static --config-out outputs/cli.yaml
-uv run python examples/cli.py --config-in outputs/cli.yaml
-```
-`examples/cli_example.yaml` provides a ready-to-use template.
-
-```python
-from torchrir import DynamicConvolver
-
-# Trajectory-mode dynamic convolution
-y = DynamicConvolver(mode="trajectory").convolve(signal, rirs)
-
-# Hop-mode dynamic convolution
-y = DynamicConvolver(mode="hop", hop=1024).convolve(signal, rirs)
-```
-Dynamic convolution is exposed via `DynamicConvolver` only (no legacy function wrappers).
-
-### Dataset-agnostic utilities
-```python
-from torchrir import (
-    CmuArcticDataset,
-    binaural_mic_positions,
-    clamp_positions,
-    load_dataset_sources,
-    sample_positions,
-)
-
-def dataset_factory(speaker: str | None):
-    spk = speaker or "bdl"
-    return CmuArcticDataset("datasets/cmu_arctic", speaker=spk, download=True)
-
-signals, fs, info = load_dataset_sources(
-    dataset_factory=dataset_factory,
-    num_sources=2,
-    duration_s=10.0,
-    rng=random.Random(0),
-)
-```
-
-### Dataset template (for future extension)
-`TemplateDataset` provides a minimal stub to implement new datasets later.
-
-### Logging
-```python
-from torchrir import LoggingConfig, get_logger, setup_logging
-
-setup_logging(LoggingConfig(level="INFO"))
-logger = get_logger("examples")
-logger.info("running torchrir example")
-```
-
-### Scene container
-```python
-from torchrir import Scene
-
-scene = Scene(room=room, sources=sources, mics=mics, src_traj=src_traj, mic_traj=mic_traj)
-scene.validate()
-```
-
-### Immutable geometry helpers
-`Room`, `Source`, and `MicrophoneArray` are immutable; use `.replace()` to update fields.
-
-### Result container
-```python
-from torchrir import RIRResult
-
-result = RIRResult(rirs=rirs, scene=scene, config=config)
-```
-
-### Simulation strategies
-```python
-from torchrir import ISMSimulator
-
-sim = ISMSimulator()
-result = sim.simulate(scene, config)
-```
-
-## Device Selection
-- `device="cpu"`: CPU execution
-- `device="cuda"`: NVIDIA GPU (CUDA) if available, otherwise fallback to CPU
-- `device="mps"`: Apple Silicon GPU via Metal (MPS) if available, otherwise fallback to CPU
-- `device="auto"`: prefer CUDA → MPS → CPU
-
-```python
-from torchrir import DeviceSpec
-
-device, dtype = DeviceSpec(device="auto").resolve()
-```
-
-## References
-- [gpuRIR](https://github.com/DavidDiazGuerra/gpuRIR)
-- [pyroomacoustics](https://github.com/LCAV/pyroomacoustics)
-- [das-generator](https://github.com/ehabets/das-generator)
-- [rir-generator](https://github.com/audiolabs/rir-generator)
-
-## Specification (Current)
-### Purpose
-- Provide room impulse response (RIR) simulation on PyTorch with CPU/CUDA/MPS support.
-- Support static and dynamic scenes with a maintainable, modern API.
-
-### Room Model
-- Shoebox (rectangular) room model.
-- 2D or 3D.
-- Image Source Method (ISM) implementation.
-
-### Inputs
-#### Scene Geometry
-- Room size: `[Lx, Ly, Lz]` (2D uses `[Lx, Ly]`).
-- Source positions: `(n_src, dim)`.
-- Microphone positions: `(n_mic, dim)`.
-- Reflection order: `max_order`.
-
-#### Acoustic Parameters
-- Sample rate: `fs`.
-- Speed of sound: `c` (default 343.0 m/s).
-- Wall reflection coefficients: `beta` (4 faces for 2D, 6 for 3D) or `t60` (Sabine).
-
-#### Output Length
-- Specify `nsample` (samples) or `tmax` (seconds).
-
-#### Directivity
-- Patterns: `omni`, `cardioid`, `hypercardioid`, `subcardioid`, `bidir`.
-- Orientation specified by vector or angles.
-
-#### Configuration
-- `SimulationConfig` controls algorithm settings (e.g., max_order, tmax, directivity, device, seed, fractional delay length, LUT, chunk sizes, compile path).
-- Passed explicitly via `simulate_rir(..., config=...)` or `simulate_dynamic_rir(..., config=...)`.
-
-### Outputs
-- Static RIR shape: `(n_src, n_mic, nsample)`.
-- Dynamic RIR shape: `(T, n_src, n_mic, nsample)`.
-- Preserves dtype/device.
-
-### Core APIs
-#### Static RIR
-```python
-room = Room.shoebox(size=[6.0, 4.0, 3.0], fs=16000, beta=[0.9] * 6)
-sources = Source.positions([[1.0, 2.0, 1.5], [4.5, 1.0, 1.2]])
-mics = MicrophoneArray.positions([[2.0, 2.0, 1.5], [3.0, 2.0, 1.5]])
-
-rir = simulate_rir(
-    room=room,
-    sources=sources,
-    mics=mics,
-    max_order=8,
-    tmax=0.4,
-    directivity="omni",
-    device="auto",
-)
-```
-
-#### Dynamic RIRs + Convolution
-```python
-rirs = simulate_dynamic_rir(
-    room=room,
-    src_traj=src_traj,   # (T, n_src, dim)
-    mic_traj=mic_traj,   # (T, n_mic, dim)
-    max_order=8,
-    tmax=0.4,
-    device="auto",
-)
-
-y = DynamicConvolver(mode="trajectory").convolve(signal, rirs)
-```
-
-### Device Control
-- `device="cpu"`, `"cuda"`, `"mps"`, or `"auto"`; resolves with fallback to CPU.
-
-## Future Work
-- Ray tracing backend: implement `RayTracingSimulator` with frequency-dependent absorption/scattering.
-- FDTD backend: implement `FDTDSimulator` with configurable grid resolution and boundary conditions.
-- Dataset expansion: add additional dataset integrations beyond CMU ARCTIC (see `TemplateDataset`).
-- Enhanced acoustics: frequency-dependent absorption and more advanced diffuse tail models.

torchrir-0.1.0.dist-info/RECORD

@@ -1,26 +0,0 @@
-torchrir/__init__.py,sha256=c2Pj4xIFcAMeGlm_vH5LbEfWOoKvF0SLzqHbh0Zvxqc,2191
-torchrir/config.py,sha256=XEWRk-OcmKR4qxZXbqoC8zUxhGkzcKFCmHqlMojiACo,2122
-torchrir/core.py,sha256=KrLO3iqKr8H8KZ071uV_lcKqoStbCwbCF5nuVNzmGkA,25507
-torchrir/directivity.py,sha256=v_t37YgeXF_IYzbnrk0TCs1npb_0yKR7zHiG8XV3V4w,1259
-torchrir/dynamic.py,sha256=tHreUlFKq9WyyAlxb10KpxwUvq1v_x2i_09dnPb0W8w,1894
-torchrir/logging_utils.py,sha256=SEcrMO5Hh1MOYHW_cjR0KhYzU9YrD0fnAq-DlEgNoIs,1848
-torchrir/plotting.py,sha256=1xeyHPjuJzOewlH1bQfqobT6g8kW2S5ru2O5TFcH5Pk,5649
-torchrir/plotting_utils.py,sha256=-KaWhjT3dDNv_09BgawBQsjweFUNRCzi2PoR3rlpTHM,5704
-torchrir/results.py,sha256=6DXBOL-5XtusSKKzW5TS7BIy35P9Rmuu5oxwsvq5F6Y,458
-torchrir/room.py,sha256=ranM9R5FtGfksOskLydMFK9AvtAosrV9dbHMaTkCbqM,4895
-torchrir/scene.py,sha256=pqFfAcvju7AHpcdqEnbyfjehVMVh2Me3Re62mC0DKdU,2284
-torchrir/scene_utils.py,sha256=NQbYu-0W3mkCCpDGeXsEOXblkk1S1ALLqnHxgTdFFvQ,1640
-torchrir/signal.py,sha256=S5tfEZOX5zeTDIpVibQ1kfe7jxwoOAG9vX_TItxmVm0,8140
-torchrir/simulators.py,sha256=sM74ILYGtJ-JZSmqLWmiGwv1dJPwPVlNPYwDMPTUYeo,2996
-torchrir/utils.py,sha256=bD3hpY0cs-ssDzV-dY4RaXYCrF63ssQz5VV5hl2xweU,9899
-torchrir/datasets/__init__.py,sha256=3T55F3fjjRR3j618ubRkMlZnQTxvXaxioFMhygxm7oQ,601
-torchrir/datasets/base.py,sha256=mCHLtGOOaD1II1alJpP6ipzkz87l-rh19NgfeLnJbDU,720
-torchrir/datasets/cmu_arctic.py,sha256=dH-1jWSXgSXlS1z6u-JTACELN0OiSbTGgqOZTDm3SjI,6615
-torchrir/datasets/template.py,sha256=KByYkCRm3cdTj4_jDvcZQ0Z4igilojJBH-6_W0-JIyc,2076
-torchrir/datasets/utils.py,sha256=15NnVdQJT1G7tFlr0gWCJZWXy6YQmcH3Lzl1WjLU01k,2568
-torchrir-0.1.0.dist-info/licenses/LICENSE,sha256=5vS_7WTsMEw_QQHEPQ_WCwovJXEgmxoEwcwOI-9VbXI,10766
-torchrir-0.1.0.dist-info/licenses/NOTICE,sha256=SRs_q-ZqoVF9_YuuedZOvVBk01jV7YQAeF8rRvlRg0s,118
-torchrir-0.1.0.dist-info/METADATA,sha256=We8i0EYL2vS9UfF_859qkL-Q5c_83G8Vef2YDzSS_Rc,6200
-torchrir-0.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-torchrir-0.1.0.dist-info/top_level.txt,sha256=aIFwntowJjvm7rZk480HymC3ipDo1g-9hEbNY1wF-Oo,9
-torchrir-0.1.0.dist-info/RECORD,,