Skip to content

Update README.md #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
f-brinkmann merged 1 commit into from
Aug 27, 2026
Merged

Update README.md #142

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@

Sofar is maybe the most complete Python package for the SOFA file format so
far. SOFA files store spatially distributed acoustic data such as impulse
responses or transfer functions. They are defined by the AES69-2022 standard
responses or transfer functions. They are defined by the AES69 standard
(see references). These are the key features of sofar

- Read, edit, and write SOFA files
- Add custom attributes to SOFA files
- Full Verification of the content of a SOFA files against AES69-2022
- Full Verification of the content of a SOFA files against AES69
- Upgrade data that uses outdated SOFA conventions
- Open license allows unrestricted use
- sofar is tested using continuous integration on
- Uses a complete definition of the AES69-2022 standard (see references) maintained at [sofa_conventions](https://github.com/pyfar/sofa_conventions)
- Uses a complete definition of the AES69 standard (see references) maintained at [sofa_conventions](https://github.com/pyfar/sofa_conventions)

Getting Started
===============
Expand All @@ -38,7 +38,6 @@ Use pip to install sofar

pip install sofar


(Requires Python >= 3.8)

If the installation fails, please check out the [help section](https://pyfar-gallery.readthedocs.io/en/latest/help).
Expand All @@ -51,11 +50,11 @@ Refer to the [contribution guidelines](https://sofar.readthedocs.io/en/stable/co
References
==========

AES69-2022: *AES standard for file exchange - Spatial acoustic data file
format*, Audio Engineering Society, Inc., New York, NY, USA.
(https://www.aes.org/publications/standards/search.cfm?docID=99)
AES69: *AES standard for file exchange - Spatial acoustic data file
format*, Audio Engineering Society, Inc., New York, NY, USA. Available from the [AES standards store](
https://aes.org/publications/standards-store/?action=standardsSearch&search=AES69&date_from=&date_to=&standards=&records=10).
Comment on lines +53 to +55

@f-brinkmann f-brinkmann Aug 7, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In case the AES search engine works, this will always link to the lates version. Currently the search engine does not work or the latest version (2022) is not available from AES.

@ahms5 ahms5 Aug 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
AES69: *AES standard for file exchange - Spatial acoustic data file
format*, Audio Engineering Society, Inc., New York, NY, USA. Available from the [AES standards store](
https://aes.org/publications/standards-store/?action=standardsSearch&search=AES69&date_from=&date_to=&standards=&records=10).
AES69: *AES standard for file exchange - Spatial acoustic data file
format*, Audio Engineering Society, Inc., New York, NY, USA. (2022) Available from the [AES standards store](
https://aes.org/publications/standards-store/?id=99).

I would be careful with linking to a search, this can break quickly. Therefore I would eather link the latest version or all versions. we have to adapt the reference and changes to sofar anyways. I would also link the current version (year).

@f-brinkmann f-brinkmann Aug 25, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Normally yes, but with AES its most certain that anything we do will break at some point. This links to the currently available most up to date version from the AES standards store, at least for now.

Fun fact: I did not find the current version on the AES homepage 🤷


P. Majdak, F. Zotter, F. Brinkmann, J. De Muynke, M. Mihocic, and M.
Noisternig, "Spatially Oriented Format for Acoustics 2.1: Introduction and
Recent Advances", *J. Audio Eng. Soc.*, vol. 70, no. 7/8, pp. 565-584,
Jul. 2022. DOI: https://doi.org/10.17743/jaes.2022.0026
Jul. 2022. DOI: [10.17743/jaes.2022.0026](https://doi.org/10.17743/jaes.2022.0026)