acoustic-spaces 3.2.0__tar.gz

acoustic_spaces-3.2.0/.clang-format

@@ -0,0 +1,5 @@
+BasedOnStyle: Google
+IndentWidth: 4
+ColumnLimit: 100
+DerivePointerAlignment: false
+PointerAlignment: Right

acoustic_spaces-3.2.0/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+
+[*.{yml,yaml,toml,md}]
+indent_size = 2
+
+[CMakeLists.txt]
+indent_size = 2

acoustic_spaces-3.2.0/.github/workflows/ci.yml

@@ -0,0 +1,278 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+    tags: ["v*"]
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - run: python -m pip install ruff
+      - run: ruff check .
+      - run: ruff format --check .
+
+  test:
+    name: Test (${{ matrix.os }}, Python ${{ matrix.python }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, macos-latest, windows-latest]
+        python: ["3.10", "3.14"]
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Software Vulkan driver (Mesa's lavapipe), for the wave solver on a GPU
+        if: runner.os == 'Linux'
+        run: sudo apt-get update && sudo apt-get install -y mesa-vulkan-drivers
+      - name: Build and install
+        run: python -m pip install ".[test,sketchup,gpu,ifc]"
+      - name: Test
+        timeout-minutes: 30  # a hung GPU test would otherwise hold the runner for 6 hours
+        run: python -m pytest -q -W error
+      - name: Smoke-test the command line
+        shell: bash  # stops at the first failing command on every platform
+        run: |
+          acoustic-spaces info
+          acoustic-spaces examples
+          acoustic-spaces validate examples/shoebox/scene.yaml
+          acoustic-spaces inspect examples/shoebox/scene.yaml
+          acoustic-spaces simulate examples/shoebox/scene.yaml --out sim --rays 5000 --length 0.8 --seed 1
+          acoustic-spaces sweep sweep.wav --duration 2 --silence 1 --repeats 2
+          python examples/measurement/virtual_recording.py sweep.wav sim/talker__seat-a.wav rec.wav
+          acoustic-spaces deconvolve rec.wav --sweep sweep.json --out ir.wav --loopback 2
+          acoustic-spaces analyze ir.wav --reference-energy 0.01
+          acoustic-spaces convolve sweep.wav sim/talker__seat-a.binaural.wav --out wet.wav --normalize
+          acoustic-spaces auralize sim talker=sweep.wav --format ambix3 --out mix.wav --normalize
+
+  uv:
+    # The setup docs/getting-started.md gives for a source checkout: `uv sync` with its dev group.
+    name: Source checkout with uv
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - run: python -m pip install uv
+      - name: Build and install with the test tools
+        run: uv sync
+      - name: Test
+        run: uv run pytest -q -W error
+      - run: uv run acoustic-spaces info
+
+  viz:
+    name: 3D view (off-screen)
+    runs-on: ubuntu-24.04
+    env:
+      # Render through OSMesa directly instead of trying (and warning about) an X display.
+      VTK_DEFAULT_OPENGL_WINDOW: vtkOSOpenGLRenderWindow
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Install off-screen OpenGL
+        run: sudo apt-get update && sudo apt-get install -y libosmesa6 libegl1 libgl1 libxrender1
+      - name: Build and install
+        run: python -m pip install ".[test,viz]"
+      - name: Test
+        run: python -m pytest -q -W error tests/test_viz.py
+      - name: Render the example scene
+        run: |
+          acoustic-spaces view examples/shoebox/scene.yaml --screenshot shoebox.png
+          acoustic-spaces view examples/shoebox/scene.yaml --paths --max-order 2 --screenshot paths.png
+          acoustic-spaces view examples/leaky_classroom/scene.yaml --leaks --screenshot leaks.png
+          acoustic-spaces simulate examples/shoebox/scene.yaml --out sim --plot --seed 1
+          acoustic-spaces sweep sweep.wav --duration 4 --silence 3 --repeats 2
+          python examples/measurement/virtual_recording.py sweep.wav sim/talker__seat-a.wav rec.wav --noise-db -70
+          acoustic-spaces deconvolve rec.wav --sweep sweep.json --out ir.wav --loopback 2
+          acoustic-spaces analyze ir.wav --reference-energy 0.01 --plot ir.png
+          acoustic-spaces animate examples/lecture_hall/scene.yaml --out particles.gif --frames 50
+      - uses: actions/upload-artifact@v6
+        with:
+          name: scene-view
+          path: |
+            shoebox.png
+            paths.png
+            leaks.png
+            ir.png
+            particles.gif
+            sim/
+
+  editor:
+    name: Editor (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, macos-latest, windows-latest]
+    env:
+      # Qt without a display; the 3D view shows a note instead, and the Xvfb step below
+      # covers it on Linux.
+      QT_QPA_PLATFORM: offscreen
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+      - name: Install the libraries Qt and its X11 platform load
+        if: runner.os == 'Linux'
+        run: >-
+          sudo apt-get update && sudo apt-get install -y xvfb libegl1 libgl1 libopengl0
+          libfontconfig1 libdbus-1-3 libxkbcommon0 libxkbcommon-x11-0 libxcb-cursor0
+          libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0
+          libxcb-shape0 libxcb-xfixes0 libxcb-xinerama0 libxcb-xkb1
+      - name: Build and install
+        run: python -m pip install ".[test,gui,ifc]"
+      - name: Test
+        run: python -m pytest -q -W error tests/test_gui.py
+      - name: Test with a display and the 3D view (Xvfb)
+        if: runner.os == 'Linux'
+        env:
+          QT_QPA_PLATFORM: xcb
+        run: xvfb-run -a -s "-screen 0 1600x1200x24" python -m pytest -q -W error tests/test_gui.py
+
+  wheels:
+    name: Wheel (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, macos-latest, windows-latest]
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+      - run: python -m pip install cibuildwheel==4.3.1
+      - name: Build and test wheels
+        run: python -m cibuildwheel --output-dir wheelhouse
+        env:
+          # Pull requests build one CPython per platform; tags build the full set from pyproject.toml.
+          CIBW_BUILD: ${{ startsWith(github.ref, 'refs/tags/') && 'cp310-* cp311-* cp312-* cp313-* cp314-*' || 'cp314-*' }}
+      - uses: actions/upload-artifact@v6
+        with:
+          name: wheels-${{ matrix.os }}
+          path: wheelhouse/*.whl
+
+  sdist:
+    name: Source distribution
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+      - run: python -m pip install build
+      - run: python -m build --sdist
+      - name: Build and import the package from the source distribution
+        shell: bash
+        run: |
+          python -m pip install dist/*.tar.gz
+          cd "$RUNNER_TEMP" && python -c "import acoustic_spaces as a; assert a.native_available(); print(a.__version__)"
+          acoustic-spaces examples --copy examples
+          acoustic-spaces validate examples/concert_hall/scene.yaml
+      - name: Check that the tag names the package's version
+        if: startsWith(github.ref, 'refs/tags/v')
+        shell: bash
+        run: test -f "dist/acoustic_spaces-${GITHUB_REF_NAME#v}.tar.gz"
+      - name: Check that the description for PyPI links to GitHub, not to relative paths
+        shell: bash
+        run: |
+          tar -xzf dist/*.tar.gz --wildcards --to-stdout '*/PKG-INFO' > "$RUNNER_TEMP/PKG-INFO"
+          grep -q '](https://raw.githubusercontent.com/naelolaiz/acoustic-spaces/main/docs/images/' "$RUNNER_TEMP/PKG-INFO"
+          if grep -n '](docs/' "$RUNNER_TEMP/PKG-INFO"; then exit 1; fi
+      - uses: actions/upload-artifact@v6
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  docs:
+    name: Documentation
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Build and install
+        run: python -m pip install ".[docs]"
+      - name: Build the documentation (warnings are errors)
+        run: python -m sphinx -W --keep-going -b html docs docs/_build/html
+      - uses: actions/upload-artifact@v6
+        with:
+          name: docs
+          path: docs/_build/html
+
+  # Releases: a tag vX.Y.Z (matching src/acoustic_spaces/_version.py), pushed or made on the
+  # Releases page, attaches the wheels and source distribution to a GitHub release and, once
+  # PyPI trusted publishing is set up and the repository variable PYPI_PUBLISH is "true",
+  # uploads them to PyPI.
+  # See "Releasing" in CONTRIBUTING.md.
+  github-release:
+    name: GitHub release
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: [lint, test, uv, viz, editor, wheels, sdist, docs]
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/download-artifact@v8
+        with:
+          path: dist
+          pattern: "{wheels-*,sdist}"
+          merge-multiple: true
+      - name: Release notes from CHANGELOG.md
+        shell: bash
+        run: |
+          awk -v v="## ${GITHUB_REF_NAME#v}" '$0 == v {on = 1; next} /^## / {on = 0} on' CHANGELOG.md > notes.md
+          test -s notes.md
+      - name: Create the release, or add the files to one made on the Releases page
+        env:
+          GH_TOKEN: ${{ github.token }}
+        shell: bash
+        run: |
+          tag="$GITHUB_REF_NAME"
+          if gh release view "$tag" > /dev/null 2>&1; then
+            gh release upload "$tag" dist/* --clobber
+            if [ -z "$(gh release view "$tag" --json body --jq .body)" ]; then
+              gh release edit "$tag" --notes-file notes.md
+            fi
+          else
+            gh release create "$tag" dist/* --title "$tag" --notes-file notes.md
+          fi
+
+  pypi:
+    name: Publish to PyPI
+    if: startsWith(github.ref, 'refs/tags/v') && vars.PYPI_PUBLISH == 'true'
+    needs: [lint, test, uv, viz, editor, wheels, sdist, docs]
+    runs-on: ubuntu-24.04
+    environment:
+      name: pypi
+      url: https://pypi.org/p/acoustic-spaces
+    permissions:
+      id-token: write  # trusted publishing: no token or password stored anywhere
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          path: dist
+          pattern: "{wheels-*,sdist}"
+          merge-multiple: true
+      - uses: pypa/gh-action-pypi-publish@release/v1

acoustic_spaces-3.2.0/.gitignore

@@ -0,0 +1,31 @@
+# Build
+build/
+dist/
+wheelhouse/
+*.egg-info/
+*.so
+*.pyd
+*.dylib
+_skbuild/
+
+# Python
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+.venv/
+uv.lock
+venv/
+
+# Editors and OS
+.vscode/
+.idea/
+.DS_Store
+
+# Simulation outputs
+*.wav
+*.sofa
+!examples/**/*.wav
+
+# Documentation
+docs/_build/