Merge pull request #94 from MaelleTtrt/improve_agreement

correction and split agreement into 2 functions

Author: mathieudpnt

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.12.7
+    hooks:
+    # Run the linter.
+    -   id: ruff-check
+        args:
+            - --fix
+            - --select=E4,E7,E9,F
+    # Run the formatter.
+    -   id: ruff-format

docs/source/_static/APOCADO_yaml.yml

@@ -10,3 +10,4 @@
   'f_min': null
   'f_max': null
   'score': null
+  'filename_format': "%Y-%m-%dT%H-%M-%S_000.wav"

docs/source/example_overview.ipynb

@@ -10,22 +10,28 @@
     "[^download]: This notebook can be downloaded as **{nb-download}\n",
     "repr(example_overview.ipynb) **.\n",
     "\n",
-    "This very simple example shows you how to make an overview plot provided a yaml configuration file and a result csv."
+    "This basic example shows you how to make an overview plot provided a YAML configuration file and a result CSV file."
    ]
   },
+  {
+   "metadata": {},
+   "cell_type": "markdown",
+   "source": "",
+   "id": "feb4595b96c1bbff"
+  },
   {
    "cell_type": "code",
-   "execution_count": null,
    "id": "6a230b00c14cc64e",
    "metadata": {},
-   "outputs": [],
    "source": [
     "from pathlib import Path\n",
     "\n",
     "import matplotlib.pyplot as plt\n",
     "\n",
     "from post_processing.dataclass.data_aplose import DataAplose"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -35,14 +41,14 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "id": "c19ddde8bf965ee8",
    "metadata": {},
-   "outputs": [],
    "source": [
-    "yaml_file = Path(r\"resource/APOCADO_yaml.yml\")\n",
+    "yaml_file = Path(r\"_static/APOCADO_yaml.yml\")\n",
     "data = DataAplose.from_yaml(file=yaml_file)"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -52,15 +58,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "id": "cf59962e0e23eb96",
    "metadata": {},
-   "outputs": [],
    "source": [
     "data.overview()\n",
     "plt.tight_layout()\n",
     "plt.show()"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   }
  ],
  "metadata": {

pyproject.toml

@@ -37,6 +37,7 @@ dev = [
     "sphinx-book-theme>=1.1.4",
     "sphinx-copybutton>=0.5.2",
     "coverage>=7.11.0",
+    "pre-commit>=4.5.1",
 ]
 
 [tool.ruff.lint.flake8-copyright]