Enhancement/finalize pyroomacoustics

example_settings/pyroomacoustics_setting.json

@@ -0,0 +1,48 @@
+{
+    "type": "simulationSettings",
+    "options": [
+        {
+            "name": "Speed of sound",
+            "id": "c0",
+            "type": "float",
+            "display": "text",
+            "min": 100,
+            "max": 500,
+            "default": 343,
+            "step": 1,
+            "endAdornment": "m/s"
+        },
+        {
+            "name": "Air density",
+            "id": "rho0",
+            "type": "float",
+            "display": "text",
+            "min": 0.001,
+            "max": 3,
+            "default": 1.213,
+            "step": 0.001,
+            "endAdornment": "kg/m^3"
+        },
+        {
+            "name": "Image source order",
+            "id": "image_source_order",
+            "type": "integer",
+            "display": "text",
+            "min": 1,
+            "max": 1000,
+            "default": 2,
+            "step": 1
+        },
+        {
+            "name": "Sampling rate",
+            "id": "sampling_rate",
+            "type": "integer",
+            "display": "text",
+            "min": 1000,
+            "max": 192000,
+            "default": 8000,
+            "step": 1000,
+            "endAdornment": "Hz"
+        }
+    ]
+}

methods-config.json

@@ -28,5 +28,15 @@
         "settings":"my_new_setting.json",
         "repositoryURL":"",
         "documentationURL":""
+    },
+    {
+        "simulationType": "Pyroomacoustics",
+        "containerImage": "pyroomacoustics_image:latest",
+        "envVars": {},
+        "label": "Pyroomacoustics",
+        "settings": "pyroomacoustics_setting.json",
+        "entryFile": "__main__.py",
+        "repositoryURL": "https://github.com/LCAV/pyroomacoustics",
+        "documentationURL": "https://pyroomacoustics.readthedocs.io"
     }
 ]

pyroomacoustics_method/pyproject.toml

@@ -30,6 +30,7 @@ dependencies = [
     "gmsh",
     "pyroomacoustics>=0.8.0",
     "requests",
+    "pyfar>=0.8.0",
 ]
 
 [project.optional-dependencies]
@@ -73,3 +74,38 @@ pyroomacoustics_interface = "pyroomacoustics_interface:main"
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 79
+lint.ignore = [
+    "D200",   # One-line docstring should fit on one line with quotes
+    "D202",   # No blank lines allowed after function docstring
+    "D205",   # 1 blank line required between summary line and description
+    "D401",   # First line should be in imperative mood
+    "D404",   # First word of the docstring should not be "This"
+    "B006",   # Do not use mutable data structures for argument defaults
+    "B008",   # Do not perform calls in argument defaults
+    "PT018",  # Assertion should be broken down into multiple parts
+    "PT019",  # Fixture `_` without value is injected as parameter
+
+]
+lint.select = [
+    "B",      # bugbear extension
+    "ARG",    # Remove unused function/method arguments
+    "C4",     # Check for common security issues
+    "E",      # PEP8 errors
+    "F",      # Pyflakes
+    "W",      # PEP8 warnings
+    "D",      # Docstring guidelines
+    "NPY",    # Check all numpy related deprecations
+    "D417",   # Missing argument descriptions in the docstring
+    "PT",     # Pytest style
+    "A",      # Avoid builtin function and type shadowing
+    "ERA",    # No commented out code
+]
+
+# Ignore missing docstrings in tests
+
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"