DEISM Documentation

DEISM is a Python package for room-acoustics simulation with directivity-aware source and receiver models. The current documentation is organized around the class-based workflow implemented by deism.core_deism.DEISM.

Start here

• Introduction for the project scope and published references

• Installation for environment setup and verification

• Quickstart for the shortest working class-based runs

• Workflows for shoebox versus convex execution order

• Parameter Dependencies for update-order and rerun rules

Quick Links

• Academic publications - Jump to all publications

• Main Paper - Main JASA paper

• Directivity Formulation - Directivity formulation paper

• Arbitrary Geometries - Arbitrary geometries paper

Contents:

• Introduction
  • Overview
  • Key Features
  • Current documentation focus
  • Applications
  • Academic publications
• Installation
  • Supported environments
  • Check Python version
  • Recommended user install
  • Developer install from source
  • Conda-based environment
  • Build tools
  • Optional tools
  • Verify the installation
  • What to expect after installation
  • Common issues
• Quickstart
  • Choose a workflow
  • Shoebox quickstart
  • Convex quickstart
• Workflows
  • Shared structure
  • Hard versus flexible ordering
  • Shoebox workflow
  • Convex workflow
  • Backends
  • Best practices
• Configuration
  • Configuration-file selection
  • Main configuration groups
  • Important runtime mappings
  • Mode-specific frequency groups
  • Material input rules
  • Room-specific notes
• Parameter Dependencies
  • Why this matters
  • Method dependency summary
  • Hard ordering rules
  • Shoebox versus convex ordering
  • Change-impact guide
  • Practical rerun rules
  • Tracking refresh provenance
• Examples
  • Recommended starting points
  • Class-based workflow examples
  • Advanced and legacy research scripts
  • Paper reproduction examples
  • Other scripts
• API Reference
  • Primary public class
  • Supporting helpers
  • Convex-room internals
  • Important runtime fields
  • Directivity data expectations
• Troubleshooting
  • Wrong update order
  • Directivity frequency mismatch
  • Convex-room ordering problems
  • Missing directivity or reference data files
  • Optional compiler issues
  • LaTeX plotting failures
  • Legacy example confusion
  • Ray backend questions

Indices and tables

• Index

• Module Index

• Search Page