treble_tsdk API Reference

Welcome to the treble_tsdk API reference documentation. This documentation is automatically generated from the source code docstrings.

Overview

The treble_tsdk package provides a Python SDK for acoustic simulation and analysis. It enables users to:

  • Create and manage acoustic simulation projects

  • Define 3D geometry and material properties

  • Configure sound sources and receivers

  • Run acoustic simulations using wave-based (DG) and ray-tracing (GA) solvers

  • Process and analyze simulation results

  • Generate Device Related Transfer Functions (DRTFs)

Getting Started

To use the SDK, first authenticate and create a client:

import treble_tsdk as tsdk

# Authenticate
client = tsdk.TSDK()

# Get or create a project
project = client.get_or_create_project("My Project")

API Documentation

Indices and tables