sofar 1.1.3__py2.py3-none-any.whl → 1.2.0__py2.py3-none-any.whl

{sofar-1.1.3.dist-info → sofar-1.2.0.dist-info}/RECORD

@@ -1,9 +1,14 @@
-sofar/__init__.py,sha256=AARVq-KAV2huia8cGZpzHZGUjMtJ1H1yGU_vg6RKn98,595
-sofar/io.py,sha256=XdkfG6jo4RI8JqUgXEfx2ka06_CfffPJXs0HqeMSri0,15761
-sofar/sofa.py,sha256=QVr0UKr-aqo2K7_PEHtXk9VuvrjE36QgcYIqFJ6KBrc,68255
-sofar/update_conventions.py,sha256=36ba0cAVtKppJCrsEhP2aiv1DGEtxNx06hsUAERDlwM,16753
-sofar/utils.py,sha256=0JwYLLyVu1ZcAfUQKSucywcQPlHB2Ojez7fxIXhuaFw,10754
+sofar/__init__.py,sha256=nhW1fJLKRZkqICK1YYBXF8P3iUsYxMF_511AQbl7DD4,619
+sofar/io.py,sha256=6IYxnVXaaZ__c5nswbG1zcoCYlyCordvFlAff0vNSH0,16055
+sofar/sofa.py,sha256=Yv79CuDjy3P-_INE9GHSWsSpaLt6dQx8FnypmgD-gbU,69152
+sofar/sofastream.py,sha256=4aJ4U3RWE-tW7ORPXY9nmWnCXHQyFmmNMtcAfzhF-8s,9893
+sofar/update_conventions.py,sha256=sw-RZp9wkeh_-b93dHVdo-1WXuR984azVByf3I-gKU4,17981
+sofar/utils.py,sha256=T0IZ5RTsOEHHooNwoWAE_r-rA_tU6mCfHog9wGqxDXU,10755
 sofar/sofa_conventions/VERSION,sha256=IuQRql5P3qfPUQuJwuh-RX5TvI_Wd4bDdSm8VLNQqds,34
+sofar/sofa_conventions/conventions/AnnotatedEmitterAudio_0.2.csv,sha256=q1fOy9QqskNjsV2b-rn9GDTThOo-AUKGORMmXSgp83w,2348
+sofar/sofa_conventions/conventions/AnnotatedEmitterAudio_0.2.json,sha256=lznoLbG6HYvPAZ-alVoWgfBXHFDeMb0PNnyOWoag3-Y,8420
+sofar/sofa_conventions/conventions/AnnotatedReceiverAudio_0.2.csv,sha256=MHBEkaSfiHm-d-8EAqL40M-0wt8couJfO2Q-Ff4SoEs,2360
+sofar/sofa_conventions/conventions/AnnotatedReceiverAudio_0.2.json,sha256=2Wf1XgP4BNhI1lNlgnFabX6mUC2pT0IGLW92mjY82hY,8432
 sofar/sofa_conventions/conventions/FreeFieldDirectivityTF_1.1.csv,sha256=Wait37FTh6ROKgpX7-JsVM-ohtKfsdHjxVL5vN7uTTs,5510
 sofar/sofa_conventions/conventions/FreeFieldDirectivityTF_1.1.json,sha256=sm8Pj_Z1n1tW2jYlu00eikR3yCcANEm_Kw5Eq9jrbw4,13138
 sofar/sofa_conventions/conventions/FreeFieldHRIR_1.0.csv,sha256=C_fc7wHjBLc2krPja33sQaDSZDvlr80GSsgOj904GBY,2479
@@ -36,6 +41,10 @@ sofar/sofa_conventions/conventions/SingleRoomMIMOSRIR_1.0.csv,sha256=2OzG5t9rYzD
 sofar/sofa_conventions/conventions/SingleRoomMIMOSRIR_1.0.json,sha256=5tjPriXZk8WEIr15i41L7hQRwAxzw_gA0nxWkZfe_7g,14346
 sofar/sofa_conventions/conventions/SingleRoomSRIR_1.0.csv,sha256=l7aeLNxbOyXgfQIjCo3QzpRpBonMp9ssfhps4fejHxc,4199
 sofar/sofa_conventions/conventions/SingleRoomSRIR_1.0.json,sha256=gVwyzGni9e3w5wehnxe6Oe5knO2Np5doHYLzRsfrlfc,14491
+sofar/sofa_conventions/conventions/deprecated/AnnotatedEmitterAudio_0.1.csv,sha256=pHwICgmCtMNdGBHPItuydYuX32myAEqCWtGSKBJR8_s,2355
+sofar/sofa_conventions/conventions/deprecated/AnnotatedEmitterAudio_0.1.json,sha256=p-WppnTuOaEFj0WlKxiM47H92pmHkIFZ9jX6TV0iLQE,8403
+sofar/sofa_conventions/conventions/deprecated/AnnotatedReceiverAudio_0.1.csv,sha256=A8doF2goKhvf1QumQOx-k_MsZKVJRHZiRbYCAXjxrTI,2367
+sofar/sofa_conventions/conventions/deprecated/AnnotatedReceiverAudio_0.1.json,sha256=dzSUPEqXT0BG0TeTa7r4zZJS01le1dJTdftBOgUXV18,8415
 sofar/sofa_conventions/conventions/deprecated/FreeFieldDirectivityTF_1.0.csv,sha256=Ha6178_LxRod-L2UcI7SX3o6Cf1YRFs1zgIpn0kd0rA,5125
 sofar/sofa_conventions/conventions/deprecated/FreeFieldDirectivityTF_1.0.json,sha256=GcOb3cbv63C7S4cJ7IVvU7NAAd1h8mA7RHaAFQ_jqz8,12627
 sofar/sofa_conventions/conventions/deprecated/GeneralFIRE_1.0.csv,sha256=2_ed7Y0CGJmCx9V3X7L4gipJ94nLzH7Jl9fXXtI7rLQ,1988
@@ -56,20 +65,26 @@ sofar/sofa_conventions/conventions/deprecated/SingleRoomDRIR_0.2.csv,sha256=JsPE
 sofar/sofa_conventions/conventions/deprecated/SingleRoomDRIR_0.2.json,sha256=oR-qubagKs28ICI7243Ep2zX0AFn_8lvYPNPseg16O8,8097
 sofar/sofa_conventions/conventions/deprecated/SingleRoomDRIR_0.3.csv,sha256=l6PAKjsNuaFHVUlT4rVdZY9Pj7nh_jF8d82i5YSbkss,1999
 sofar/sofa_conventions/conventions/deprecated/SingleRoomDRIR_0.3.json,sha256=ccCvFNWYwATIRCPxQke73ckogc2Y3hBP97_JOtPusns,8097
-sofar/sofa_conventions/rules/deprecations.json,sha256=hyq112XNfojROZsAEbcV7EOLin-xaTiNi4o4WdplS74,453
-sofar/sofa_conventions/rules/rules.json,sha256=iH8e5UUVRQcGZ_AoULk4A2IiAT1yK7R2CvRQyCMYhYA,22501
+sofar/sofa_conventions/conventions/deprecated/SingleTrackedAudio_0.1.csv,sha256=Vjx7u0MaYsUFbzKPKgAWxeT9iqqNC5gF_P6RqG-dd78,2397
+sofar/sofa_conventions/conventions/deprecated/SingleTrackedAudio_0.1.json,sha256=XE2ai8ybHxzrWKDUooE7LpBoiFS3pf-5RiG17Jy08E0,8650
+sofar/sofa_conventions/conventions/deprecated/SingleTrackedAudio_0.2.csv,sha256=svRCzuJl_wR8Y1LUS7O_N1KkWtxTB8lrhQXBi7uif60,2727
+sofar/sofa_conventions/conventions/deprecated/SingleTrackedAudio_0.2.json,sha256=g64b-uuzPlm_nXvoRgMxcydDTq5LSsX3mmeFN-tl6-w,9531
+sofar/sofa_conventions/rules/deprecations.json,sha256=adYMivYOicwuAUFAsoiDcGHdhre5ZqNOhIe9BX2mM7M,534
+sofar/sofa_conventions/rules/rules.json,sha256=45fbAzUczWYSpZZj7A15psx2Rh77xz56eT2CagKrwts,23096
 sofar/sofa_conventions/rules/unit_aliases.json,sha256=QXgOfpe8bnmUybVhSSj3nIUYw50CAVehh7sdFNPFl0k,212
-sofar/sofa_conventions/rules/upgrade.json,sha256=viHPPqBaPblE-fY8BOuVUraQYrBhckrS3w5XKqHCTIE,5167
+sofar/sofa_conventions/rules/upgrade.json,sha256=0o9sTQELnEUXl_teZLjO1Azx7yqrTHmYzT8_7VB9LtM,6025
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/conftest.py,sha256=3J_BsyJ-_L5145UY_17pb56AptLZr62QFt-zhzE0OE8,738
 tests/test_deprecations.py,sha256=coHOEq5XUquYxRge8XKeg005M84wcgSHTEE--CoEar4,584
-tests/test_io.py,sha256=xMBdWP3vdnk_6aYAhg30nEgGvPfYm30a1qouGHIwRNo,11808
-tests/test_sofa.py,sha256=DpiI517T-gLoajy9nQCHT7ouxM40JwirsqkVMFT5cWo,11314
-tests/test_sofa_upgrade_conventions.py,sha256=HqIuvFFub1_HCH6qHTLPcPyBZ2ayDKzmZR7RwnTxo_o,3377
-tests/test_sofa_verify.py,sha256=BW-j7B-81PXqTSKFa4LnkAGfUnIoc-yssuMwGt0UQTM,15830
-tests/test_utils.py,sha256=yT290xCaeDW4l3DHUeFGiVmLe9xMguETN1NAGRTJ-X4,8307
-sofar-1.1.3.dist-info/AUTHORS.rst,sha256=JGcf9PJwl0w14PgTRjI3HXpcwDbkGbUN4mkYoZ8smL8,164
-sofar-1.1.3.dist-info/LICENSE,sha256=qdGH_RUPveBBfGYShm6OIBd6bRJdwp3fDCpjMsowmqA,1068
-sofar-1.1.3.dist-info/METADATA,sha256=T7R1WvTW7qDQbXm0QiwfJntqDRDb9Z3YepqjEyEa1aw,3242
-sofar-1.1.3.dist-info/WHEEL,sha256=-G_t0oGuE7UD0DrSpVZnq1hHMBV9DD2XkS5v7XpmTnk,110
-sofar-1.1.3.dist-info/top_level.txt,sha256=2JSMmeQ5zeMumFynTJU1oODh09wxSiN3gFpsY-bNsSo,12
-sofar-1.1.3.dist-info/RECORD,,
+tests/test_io.py,sha256=ndXn3IYFzs8OZDbeFkSBSFy7411PYwDsChPnS5zlZdE,12014
+tests/test_sofa.py,sha256=lYHVwJFnAD5qqIHkHk84ErAa2ZXblhNPgKnLjAIcw3M,11315
+tests/test_sofa_upgrade_conventions.py,sha256=hveRnbmPpWFYUSuAmhbRRL5ixbNLN4XoVMAPM6D2aA0,3725
+tests/test_sofa_verify.py,sha256=5eQivsNoJh3oXwMud61egbsLBvPorFp739kPSwJU-U0,15835
+tests/test_sofastream.py,sha256=HWbYrWktONIttFzoKC8n3DGkeUocdq5qf1XDbrv-B2k,3865
+tests/test_utils.py,sha256=afzboGH-gUxc3tUb4yKRzH-y60bDHTqNZnco6Can4yE,8814
+sofar-1.2.0.dist-info/AUTHORS.rst,sha256=JGcf9PJwl0w14PgTRjI3HXpcwDbkGbUN4mkYoZ8smL8,164
+sofar-1.2.0.dist-info/LICENSE,sha256=OOdX8H69BDppTN8KCBp8l2_yDbH6sW-YuSEKDgZPuL4,1079
+sofar-1.2.0.dist-info/METADATA,sha256=J5XgYBeTxVURL4SIvzUlBjdFrUvbLAdKs83_86RUs18,4086
+sofar-1.2.0.dist-info/WHEEL,sha256=qUzzGenXXuJTzyjFah76kDVqDvnk-YDzY00svnrl84w,109
+sofar-1.2.0.dist-info/top_level.txt,sha256=2JSMmeQ5zeMumFynTJU1oODh09wxSiN3gFpsY-bNsSo,12
+sofar-1.2.0.dist-info/RECORD,,

{sofar-1.1.3.dist-info → sofar-1.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (74.1.2)
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any

tests/conftest.py

@@ -0,0 +1,27 @@
+import pytest
+import numpy as np
+import sofar as sf
+
+
+# Temporary SOFA-file
+@pytest.fixture
+def temp_sofa_file(tmp_path_factory):
+    """
+    Temporary small SOFA file.
+    To be used when data needs to be read from a SOFA file for testing.
+    Contains custom data for "Data_IR", "GLOBAL_RoomType" and
+    "Data_SamplingRate_Units".
+
+    Returns
+    -------
+    filename : SOFA file
+        Filename of temporary SOFA file
+    """
+
+    filename = tmp_path_factory.mktemp("data") / "test_sofastream.sofa"
+    sofa = sf.Sofa("SimpleFreeFieldHRIR")
+    sofa.Data_IR = np.array([[0, 1], [2, 3], [4, 5]])
+    sofa.GLOBAL_RoomType = "free field"
+    sofa.Data_SamplingRate_Units = "hertz"
+    sf.write_sofa(filename, sofa)
+    return filename

tests/test_io.py

@@ -13,6 +13,7 @@ from pytest import raises
 import numpy as np
 import numpy.testing as npt
 from netCDF4 import Dataset
+from packaging.version import parse
 
 
 def test_read_write_sofa(capfd):
@@ -165,11 +166,14 @@ def test_roundtrip(mandatory):
     for name, version in names_versions:
         print(f"Testing: {name} {version}")
 
-        if name in deprecations["GLOBAL:SOFAConventions"]:
-            # deprecated conventions can not be written
+        # writing deprecated and proposed conventions is not tested
+        if name in deprecations["GLOBAL:SOFAConventions"] or \
+                parse(version) < parse('1.0'):
             sofa = sf.Sofa(name, mandatory, version, verify=False)
-            with pytest.warns(UserWarning, match="deprecations"):
-                sofa.verify(mode="read")
+            # non stable conventions are not verified
+            if parse(version) >= parse('1.0'):
+                with pytest.warns(UserWarning, match="deprecations"):
+                    sofa.verify(mode="read")
         else:
             # test full round-trip for other conventions
             file = os.path.join(temp_dir.name, name + ".sofa")
@@ -182,7 +186,7 @@ def test_roundtrip(mandatory):
 
 def test_roundtrip_multidimensional_string_variable():
     """
-    Test writing and reading multidimensional string variables (Wringting
+    Test writing and reading multidimensional string variables (Writing
     string variables with one dimension is done in the other roundtrip test).
     """
 

tests/test_sofa.py

@@ -252,7 +252,7 @@ def test_add_entry():
     # variable without dimensions
     with raises(ValueError, match="dimensions must be provided"):
         sofa.add_variable("TemperatureCelsius", 25.1, "double", None)
-    # invalid dimensins
+    # invalid dimensions
     with pytest.warns(UserWarning, match="Added custom dimension T"):
         sofa.add_variable("TemperatureCelsius", [25.1, 25.2], "double", "T")
     # attribute with missing variable

tests/test_sofa_upgrade_conventions.py

@@ -85,10 +85,15 @@ def test_upgrade_conventions(path, capfd):
     out, _ = capfd.readouterr()
 
     # don't verify conventions that might require user action after
-    if os.path.basename(path) in ["FreeFieldDirectivityTF_1.0.json"]:
+    if os.path.basename(path) in [
+            "FreeFieldDirectivityTF_1.0.json",
+            "SingleTrackedAudio_0.1.json",
+            "SingleTrackedAudio_0.2.json"]:
         # FreeFieldDirectivityTF_1.0
         # - optional dependency GLOBAL_EmitterDescription
         #   might need to be added
+        # SingleTrackedAudio_0.x
+        # - can be updated to multiple conventions depending on the content
         verify = False
     else:
         verify = True
@@ -98,5 +103,9 @@ def test_upgrade_conventions(path, capfd):
             sofa.upgrade_convention(target, verify=verify)
             out, _ = capfd.readouterr()
             assert "Upgrading" in out
+    elif deprecated:
+        sofa.upgrade_convention()
+        out, _ = capfd.readouterr()
+        assert "is missing upgrade rules" in out
     else:
         assert not deprecated

tests/test_sofa_verify.py

@@ -11,7 +11,7 @@ import warnings
 # get verification rules
 _, unit_aliases, _, _ = sf.Sofa._verification_rules()
 
-# directory containing the verificatin data
+# directory containing the verification data
 basedir = os.path.join(os.path.dirname(__file__), "..", "sofar",
                        "sofa_conventions", "data")
 
@@ -192,11 +192,11 @@ def test_data_types(capfd):
         sofa.verify()
 
     sofa.Data_IR = "1"
-    with raises(ValueError, match="- Data_IR must be int, float"):
+    with raises(ValueError, match="- Data_IR must be int or float"):
         sofa.verify()
 
     sofa.Data_IR = 1+1j
-    with raises(ValueError, match="- Data_IR must be int, float"):
+    with raises(ValueError, match="- Data_IR must be int or float"):
         sofa.verify()
 
     # test invalid data with issue_handling "print" and "return"

tests/test_sofastream.py

@@ -0,0 +1,126 @@
+from sofar import SofaStream
+from tempfile import TemporaryDirectory
+from pytest import raises
+import netCDF4
+import numpy as np
+import os
+import sofar as sf
+
+
+def test_sofastream_output(temp_sofa_file):
+
+    with SofaStream(temp_sofa_file) as file:
+        obj = file
+        var = file.Data_IR
+        var_data = var[:]
+        var_attr = file.Data_SamplingRate_Units
+        att_data = file.GLOBAL_RoomType
+
+        # check SofaStream instance
+        isinstance(obj, SofaStream)
+        # check returned variable type
+        isinstance(var, netCDF4._netCDF4.Variable)
+        # variable values
+        isinstance(var_data, np.ma.core.MaskedArray)
+        np.testing.assert_array_equal(var_data.squeeze(),
+                                      np.array([[0, 1], [2, 3], [4, 5]]))
+        assert var_attr == 'hertz'
+        # attribute values
+        isinstance(att_data, str)
+        assert att_data == "free field"
+
+
+def test_sofastream_attribute_error(temp_sofa_file):
+
+    with SofaStream(temp_sofa_file) as file:
+        with raises(AttributeError,
+                    match="Wrong_Attribute is not contained in SOFA-file"):
+            file.Wrong_Attribute
+
+
+def test_sofastream_inspect(capfd, temp_sofa_file):
+
+    tempdir = TemporaryDirectory()
+    inspect_file = os.path.join(tempdir.name, "info.txt")
+
+    with SofaStream(temp_sofa_file) as file:
+        file.inspect(inspect_file)
+        out, _ = capfd.readouterr()
+
+    sofa = sf.read_sofa(temp_sofa_file)
+    sofa.inspect()
+    out_sofa, _ = capfd.readouterr()
+
+    assert out_sofa == out
+
+    # check text file
+    with open(inspect_file, "r") as out_inspect:
+        text = out_inspect.readlines()
+    assert out == "".join(text)
+
+
+def test_list_dimensions(capfd, tmp_path_factory):
+
+    filename = tmp_path_factory.mktemp("data") / "test_sofastream_dim.sofa"
+
+    # test FIR Data
+    sofa = sf.Sofa("GeneralFIR")
+    sf.write_sofa(filename, sofa)
+    with SofaStream(filename) as file:
+        file.list_dimensions
+        out, _ = capfd.readouterr()
+        assert "N = 1 samples" in out
+
+    # test TF Data
+    sofa = sf.Sofa("GeneralTF")
+    sf.write_sofa(filename, sofa)
+    with SofaStream(filename) as file:
+        file.list_dimensions
+        out, _ = capfd.readouterr()
+        assert "N = 1 frequencies" in out
+
+    # test SOS Data
+    sofa = sf.Sofa("SimpleFreeFieldHRSOS")
+    sf.write_sofa(filename, sofa)
+    with SofaStream(filename) as file:
+        file.list_dimensions
+        out, _ = capfd.readouterr()
+        assert "N = 6 SOS coefficients" in out
+
+    # test non spherical harmonics data
+    sofa = sf.Sofa("GeneralFIR")
+    sf.write_sofa(filename, sofa)
+    with SofaStream(filename) as file:
+        file.list_dimensions
+        out, _ = capfd.readouterr()
+        assert "E = 1 emitter" in out
+        assert "R = 1 receiver" in out
+
+    # test spherical harmonics data
+    sofa.EmitterPosition_Type = "spherical harmonics"
+    sofa.ReceiverPosition_Type = "spherical harmonics"
+    sofa.EmitterPosition_Units = "degree, degree, metre"
+    sofa.ReceiverPosition_Units = "degree, degree, metre"
+    sf.write_sofa(filename, sofa)
+    with SofaStream(filename) as file:
+        file.list_dimensions
+        out, _ = capfd.readouterr()
+    assert "E = 1 emitter spherical harmonics coefficients" in out
+    assert "R = 1 receiver spherical harmonics coefficients" in out
+
+
+def test_get_dimensions(tmp_path_factory):
+    """Test getting the size of dimensions"""
+    filename = tmp_path_factory.mktemp("data") / "test_sofastream_dim.sofa"
+
+    # test FIR Data
+    sofa = sf.Sofa("GeneralFIR")
+    sf.write_sofa(filename, sofa)
+
+    with SofaStream(filename) as file:
+        size = file.get_dimension('N')
+        assert size == 1
+
+        # test wrong dimension error
+        with raises(ValueError, match="Q is not a valid dimension"):
+            file.get_dimension("Q")

tests/test_utils.py

@@ -98,22 +98,32 @@ def test_update_conventions(capfd):
     # first run to test if conventions were updated
     sf.update_conventions(conventions_path=work_dir, assume_yes=True)
     out, _ = capfd.readouterr()
-    assert "added convention: GeneralTF_2.0" in out
-    assert "updated convention: GeneralFIR_1.0" in out
-    assert "deprecated convention: MultiSpeakerBRIR_0.3" in out
+    assert "add convention: GeneralTF_2.0" in out
+    assert os.path.isfile(os.path.join(work_dir, "GeneralTF_2.0.csv"))
+    assert "update convention: GeneralFIR_1.0" in out
+    assert "deprecate convention: MultiSpeakerBRIR_0.3" in out
     assert not os.path.isfile(
         os.path.join(work_dir, "MultiSpeakerBRIR_0.3.csv"))
     assert not os.path.isfile(
         os.path.join(work_dir, "MultiSpeakerBRIR_0.3.json"))
-    assert "updated deprecated convention: SimpleFreeFieldHRIR_0.4" in out
-    assert "added deprecated convention: SimpleFreeFieldTF_0.4" in out
+    assert os.path.isfile(
+        os.path.join(work_dir, "deprecated", "MultiSpeakerBRIR_0.3.csv"))
+    assert os.path.isfile(
+        os.path.join(work_dir, "deprecated", "MultiSpeakerBRIR_0.3.json"))
+    assert "update deprecated convention: SimpleFreeFieldHRIR_0.4" in out
+    assert "add deprecated convention: SimpleFreeFieldTF_0.4" in out
+    assert os.path.isfile(
+        os.path.join(work_dir, "deprecated", "SimpleFreeFieldTF_0.4.csv"))
+    assert os.path.isfile(
+        os.path.join(work_dir, "deprecated", "SimpleFreeFieldTF_0.4.json"))
 
     # second run to make sure that up to date conventions are not overwritten
     sf.update_conventions(conventions_path=work_dir, assume_yes=True)
     out, _ = capfd.readouterr()
-    assert "added" not in out
-    assert "updated" not in out
-    assert "deprecated" not in out
+    assert "add" not in out
+    assert "update" not in out
+    assert "deprecate" not in out
+    assert "already up to date" in out
 
 
 def test__compile_conventions():

sofar-1.1.3.dist-info/METADATA

@@ -1,91 +0,0 @@
-Metadata-Version: 2.1
-Name: sofar
-Version: 1.1.3
-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
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.8
-License-File: LICENSE
-License-File: AUTHORS.rst
-Requires-Dist: netCDF4
-Requires-Dist: numpy >=1.14.0
-Requires-Dist: beautifulsoup4
-Requires-Dist: requests
-Requires-Dist: packaging
-
-======
-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