Skip to main content

ambiscape

CI docs PyPI version Python License: MIT DOI

ambiscape is a Python toolbox for analysing soundscapes—the sonic ambiences of rooms and other places. It reads mono, stereo, binaural, or first-order ambisonic recordings of any length and describes a place's sound as a whole: level, spectrum, space, rhythm, sources, and more. Several recorders spread through a building can be read together as one acoustic network.

Install

pip install ambiscape

Optional extras add psychoacoustic indicators, machine listening, music analysis, live capture, and spatial visuals. See the install guide.

Quickstart

Point analyze at a session—a folder of WAV files from one recording occasion:

ambiscape analyze my-session/

This streams the audio in constant memory, however long it is. It extracts features, computes descriptors (Leq, LAeq, percentile levels, event statistics, diffuseness, and more), renders overview figures, and writes a README.md summarising the session. Start by reading that README and looking at analysis/overview.png:

Session overview figure: level timeline, spectrogram, anglegram, and diffuseness lane on one clock. The quickstart guide continues from there, on the command line and in Python.

Commands

analyze is one of nearly forty subcommands. The others cover taxonomy annotation, rhythm and tonality, room acoustics and impulse responses, ecological and source-domain indices, perceptual surveys, multi-recorder building networks (network), corpus aggregation, and privacy-aware publishing. The command overview lists them all; ambiscape --help prints the same list.

Documentation

  • User guide & API reference—the session model, feature and descriptor definitions, and a page per analysis module.
  • Wiki—field-recording protocol, recipes, worked case studies, design rationale, and research context.

ambiscape analyses sound; its sister toolbox MGT-python analyses video. The two meet at file boundaries—see Working with other packages.

The four toolboxes

Four packages from the fourMs lab, each released separately on PyPI. Which one you want is decided by what you have in hand rather than by what you want to know:

you have use it gives you
a recording of a place — mono, stereo, binaural or ambisonic ambiscape (this one) the sonic ambience of that place: level, spectrum, space, rhythm, sources
a motion time series from a body — optical markers, an accelerometer, a respiration belt, a force plate micromotion quantity of motion, posture, balance, and the band conventions the others follow
a video file, with or without its sound musicalgestures motiongrams, videograms, motion analysis from ordinary video
a folder of music, or a concert recording musiscape many tracks and albums compared at a glance

Where a measure appears in more than one package it has a single owner and a single implementation, so the answer does not depend on which package you called. micromotion owns filtering, lag estimation and circular statistics; ambiscape owns the soundscape descriptors; musicalgestures owns everything that starts from pixels. Music analysis moved out of ambiscape into musiscape on 2026-08-12, so a release of either from before then may still carry the other's functions.

ambiscape installs and runs without any of the others. It keeps its own copy of six short circular-statistics primitives rather than taking a dependency for them, which is a deliberate exception to the single-owner rule: tests/test_circstats_agreement.py checks them against micromotion's and skips when it is not installed. That test exists because the two Rayleigh implementations were once found to disagree on about a fifth of random cases — ambiscape used Zar's series expansion and micromotion uses Wilkie's approximation, both published, neither wrong, and nothing anywhere saying they were meant to match.

Licence

MIT—see LICENSE.

Credits

ambiscape is developed as part of the AMBIENT project at fourMs / RITMO, University of Oslo, supported by the Research Council of Norway. It is the streaming companion to ambiviz, which renders rich spatial visuals from short ambisonic files.

Citing

Cite the concept DOI, which always resolves to the newest version:

Jensenius, A. R., & Guo, J. (2026). ambiscape: analysis of soundscapes from mono, stereo, binaural and ambisonic recordings [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.21965234

Where the exact behaviour matters, add the version you ran. Every release has its own DOI, listed on the Zenodo record.

An older concept DOI, https://doi.org/10.5281/zenodo.21948997, is frozen at 0.42.0. It was created by a hand deposit made on 2026-08-15, before the Zenodo GitHub integration was archiving this repository; the integration began working the next day and every release since is under the DOI above. Zenodo cannot merge two concepts, so both records exist and only one of them advances. Cite the DOI above.

CITATION.cff in this repository carries the same information in machine-readable form.

Metadata

Release files for ambiscape 0.49.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ambiscape 0.49.0
File Size Uploaded Provenance
ambiscape-0.49.0.tar.gz 392.5 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for ambiscape 0.49.0
File Interpreter ABI Platform
ambiscape-0.49.0-py3-none-any.whl Python 3 none any Details

Total release size: 708.9 kB

Release files / ambiscape-0.49.0.tar.gz

Download URL ambiscape-0.49.0.tar.gz
Size 392.5 kB
Tags Source
SHA-256 checksum
How to use checksums
f8d963bb0a7ba4f7d8a17714c29444c2989dd8454cd6285cff2fa68f18abbf40
BLAKE2b-256 checksum
How to use checksums
bc03291515f4c8d77b547ecce9b7a21059da4e28d3a2aaea351d4a0cba204bce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 3, 2026.

Transparency log

Release files / ambiscape-0.49.0-py3-none-any.whl

Download URL ambiscape-0.49.0-py3-none-any.whl
Size 316.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9a9664c21c4840ef3717c28f83865bffb8588ea6dd8fe8aa311fc935480d7225
BLAKE2b-256 checksum
How to use checksums
68f359c8e4c081692cb8dddad8bee7bed0e4215a3ab126081a2e7d7442d535c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 3, 2026.

Transparency log

Security for ambiscape 0.49.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for ambiscape-0.49.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 3, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.49.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page