sofar 0.3.1__tar.gz → 1.1.0__tar.gz

{sofar-0.3.1 → sofar-1.1.0}/AUTHORS.rst

@@ -6,6 +6,7 @@ The sofar developers
 --------------------
 
 - Fabian Brinkmann
+- Marco Berzborn
 
 
 Funding

{sofar-0.3.1 → sofar-1.1.0}/CONTRIBUTING.rst

@@ -52,10 +52,14 @@ Ready to contribute? Here's how to set up `sofar` for local development.
 1. Fork the `sofar` repo on GitHub.
 2. Clone your fork locally and cd into the sofar directory::
 
-    $ git clone https://github.com/pyfar/sofar.git
+    $ git clone --recursive https://github.com/pyfar/sofar.git
     $ cd sofar/
 
-3. Install your local copy into a virtualenv. Assuming you have Anaconda or Miniconda installed, this is how you set up your fork for local development::
+3. Note that some graphical Git interfaces can not do the recursive clone. If the folder sofar/sofa_conventions is empty try
+
+    $ git submodule update --init
+
+4. Install your local copy into a virtualenv. Assuming you have Anaconda or Miniconda installed, this is how you set up your fork for local development::
 
     $ conda create --name sofar python
     $ conda activate sofar
@@ -63,13 +67,13 @@ Ready to contribute? Here's how to set up `sofar` for local development.
     $ pip install -e .
     $ pip install -r requirements_dev.txt
 
-4. Create a branch for local development. Indicate the intention of your branch in its respective name (i.e. `feature/branch-name` or `bugfix/branch-name`)::
+5. Create a branch for local development. Indicate the intention of your branch in its respective name (i.e. `feature/branch-name` or `bugfix/branch-name`)::
 
     $ git checkout -b name-of-your-bugfix-or-feature
 
    Now you can make your changes locally.
 
-5. When you're done making changes, check that your changes pass flake8 and the
+6. When you're done making changes, check that your changes pass flake8 and the
    tests::
 
     $ flake8 sofar tests
@@ -77,13 +81,13 @@ Ready to contribute? Here's how to set up `sofar` for local development.
 
    flake8 test must pass without any warnings for `./sofar` and `./tests` using the default or a stricter configuration. Flake8 ignores `E123/E133, E226` and `E241/E242` by default. If necessary adjust the your flake8 and linting configuration in your IDE accordingly.
 
-6. Commit your changes and push your branch to GitHub::
+7. Commit your changes and push your branch to GitHub::
 
     $ git add .
     $ git commit -m "Your detailed description of your changes."
     $ git push origin name-of-your-bugfix-or-feature
 
-7. Submit a pull request through the GitHub website.
+8. Submit a pull request through the GitHub website.
 
 Pull Request Guidelines
 -----------------------
@@ -171,6 +175,17 @@ documentation. To show the warnings again use
 before building the documentation.
 
 
+Submodules
+~~~~~~~~~~
+
+To update the submodule containing the conventions and verification rules run
+
+$ git submodule update --init --recursive
+$ git submodule update --recursive --remote
+
+and then commit the changes
+
+
 Deploying
 ~~~~~~~~~
 
@@ -185,11 +200,11 @@ Switch to main and run::
 
 $ bumpversion patch --verbose # possible: major / minor / patch
 
-Bumpversion will update all version strings, create and comitt tags by default
+Bumpversion will update all version strings, create and commit tags by default
 
 $ git push --follow-tags
 
-Travis will then deploy to PyPI if tests pass.
+Continuous integration will then deploy to PyPI if tests pass.
 
 - Merge main back into develop
 

{sofar-0.3.1 → sofar-1.1.0}/HISTORY.rst

@@ -1,6 +1,27 @@
 History
 =======
 
+1.1.0 (2023-7-7)
+----------------
+* Deprecate FreeFieldDirectivityTV 1.0 in favor of FreeFieldDirectivityTV 1.1 (according to sofaconventoins.org and AES69-2022)
+* Add `sofar.read_sofa_as_netcdf` for reading SOFA files with erroneous data
+* Document SOFA conventions on https://sofar.readthedocs.io/en/stable/resources/conventions.html. `Sofa.info()` will this be deprecated in sofar v1.3.0
+* `sofar.read_sofa` and `sofar.write_sofa` now accept filenames and path objects
+* Add testing for Python 3.11
+
+1.0.0 (2022-12-16)
+------------------
+* Use SOFA conventions of version 2.1 from https://github.com/pyfar/sofa_conventions
+* Verify SOFA data against all rules defined in the SOFA standard AES69-2022
+* Add `Sofa.upgrade_convention` for upgrading outdated conventions. This now uses explicit upgrade rules from https://github.com/pyfar/sofa_conventions
+* Remove upgrade functionality from `Sofa.verify`, `sofar.write_sofa`, and `sofar.read_sofa` for a more clear separation of functionality
+* Add `Sofa.add_missing` to add missing default data to a SOFA object using the default values specified by the SOFA convention
+* Add default parameter value to `Sofa.info`
+* Make `sofar.update_conventions` a public function again
+* Improve documentation and verbosity of command line output
+* Add private function to check congruency of conventions stored as part of SOFAtoolbox and on sofaconventions.org
+* Move to Circle CI and improve testing
+
 0.3.1 (2022-03-21)
 ------------------
 * Improvement `sofar.read`: Files with unknown Convention versions can now be read by updating to the latest or a specific version.

sofar-1.1.0/MANIFEST.in

@@ -0,0 +1,12 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+
+include sofar/sofa_conventions/VERSION
+recursive-include sofar/sofa_conventions/conventions *.csv
+recursive-include sofar/sofa_conventions/conventions *.json
+recursive-include sofar/sofa_conventions/conventions/deprecated *.csv
+recursive-include sofar/sofa_conventions/conventions/deprecated *.json
+recursive-include sofar/sofa_conventions/rules *.json

sofar-1.1.0/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.1
+Name: sofar
+Version: 1.1.0
+Summary: Maybe the most complete python package for SOFA files so far
+Home-page: https://pyfar.org/
+Download-URL: https://pypi.org/project/sofar/
+Author: The pyfar developers
+Author-email: info@pyfar.org
+License: MIT license
+Project-URL: Bug Tracker, https://github.com/pyfar/sofar/issues
+Project-URL: Documentation, https://sofar.readthedocs.io/
+Project-URL: Source Code, https://github.com/pyfar/sofar
+Keywords: sofar
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+License-File: LICENSE
+License-File: AUTHORS.rst
+
+======
+Readme
+======
+
+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
+(see references). These are the key features of sofar
+
+* Uses a complete definition of the AES69-2022 standard (see references) maintained at `sofa_conventions`_
+* Read, edit, and write SOFA files
+* Add custom attributes to SOFA files
+* Full Verification of the content of a SOFA files against AES69-2022
+* Upgrade data that uses outdated SOFA conventions
+* Open license allows unrestricted use
+* sofar is tested using continuous integration on
+
+Installation
+============
+
+Use pip to install sofar
+
+.. code-block:: console
+
+    $ pip install sofar
+
+(Requires Python >= 3.8)
+
+Getting Started
+===============
+
+Check out `read the docs`_ for example use cases a quick introduction to SOFA
+and sofar, and the complete documentation. A more detailed introduction to SOFA
+is given by Majdak et. al. 2022 (see references below) Packages related to
+sofar are listed at `pyfar.org`_. For more information on the SOFA file format
+visit `sofaconventions.org`_.
+
+Contributing
+============
+
+Refer to the `contribution guidelines`_ for more information.
+
+.. _sofa_conventions : https://github.com/pyfar/sofa_conventions
+.. _contribution guidelines: https://github.com/pyfar/sofar/blob/develop/CONTRIBUTING.rst
+.. _pyfar.org: https://pyfar.org
+.. _read the docs: https://sofar.readthedocs.io/en/latest
+.. _sofaconventions.org: https://sofaconventions.org
+
+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)
+
+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

sofar-1.1.0/README.rst

@@ -0,0 +1,59 @@
+======
+Readme
+======
+
+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
+(see references). These are the key features of sofar
+
+* Uses a complete definition of the AES69-2022 standard (see references) maintained at `sofa_conventions`_
+* Read, edit, and write SOFA files
+* Add custom attributes to SOFA files
+* Full Verification of the content of a SOFA files against AES69-2022
+* Upgrade data that uses outdated SOFA conventions
+* Open license allows unrestricted use
+* sofar is tested using continuous integration on
+
+Installation
+============
+
+Use pip to install sofar
+
+.. code-block:: console
+
+    $ pip install sofar
+
+(Requires Python >= 3.8)
+
+Getting Started
+===============
+
+Check out `read the docs`_ for example use cases a quick introduction to SOFA
+and sofar, and the complete documentation. A more detailed introduction to SOFA
+is given by Majdak et. al. 2022 (see references below) Packages related to
+sofar are listed at `pyfar.org`_. For more information on the SOFA file format
+visit `sofaconventions.org`_.
+
+Contributing
+============
+
+Refer to the `contribution guidelines`_ for more information.
+
+.. _sofa_conventions : https://github.com/pyfar/sofa_conventions
+.. _contribution guidelines: https://github.com/pyfar/sofar/blob/develop/CONTRIBUTING.rst
+.. _pyfar.org: https://pyfar.org
+.. _read the docs: https://sofar.readthedocs.io/en/latest
+.. _sofaconventions.org: https://sofaconventions.org
+
+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)
+
+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

{sofar-0.3.1 → sofar-1.1.0}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.3.1
+current_version = 1.1.0
 commit = True
 tag = True
 
@@ -20,9 +20,6 @@ exclude = .git, .tox, docs
 [aliases]
 test = pytest
 
-[tool:pytest]
-norecursedirs = private
-
 [egg_info]
 tag_build = 
 tag_date = 0

{sofar-0.3.1 → sofar-1.1.0}/setup.py

@@ -42,9 +42,10 @@ setup(
         'License :: OSI Approved :: MIT License',
         'Natural Language :: English',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
-        'Programming Language :: Python :: 3.9'
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11'
     ],
     description="Maybe the most complete python package for SOFA files so far",
     install_requires=requirements,
@@ -57,8 +58,14 @@ setup(
     setup_requires=setup_requirements,
     test_suite='tests',
     tests_require=test_requirements,
-    url='https://github.com/pyfar/sofar',
-    version='0.3.1',
+    url="https://pyfar.org/",
+    download_url="https://pypi.org/project/sofar/",
+    project_urls={
+        "Bug Tracker": "https://github.com/pyfar/sofar/issues",
+        "Documentation": "https://sofar.readthedocs.io/",
+        "Source Code": "https://github.com/pyfar/sofar",
+    },
+    version='1.1.0',
     zip_safe=False,
-    python_requires='>=3.7'
+    python_requires='>=3.8'
 )

sofar-1.1.0/sofar/__init__.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+
+"""Top-level package for sofar."""
+
+__author__ = """The pyfar developers"""
+__email__ = 'info@pyfar.org'
+__version__ = '1.1.0'
+
+from .sofa import Sofa
+
+from .io import read_sofa, read_sofa_as_netcdf, write_sofa
+
+from .utils import (list_conventions,
+                    equals,
+                    version)
+
+from .update_conventions import update_conventions
+
+
+__all__ = ['Sofa',
+           'update_conventions',
+           'list_conventions',
+           'read_sofa',
+           'read_sofa_as_netcdf',
+           'write_sofa',
+           'equals',
+           'version']