introducing data model blast

wip

wip

cleanup

.github/workflows/build.yml

@@ -16,7 +16,7 @@ jobs:
       with:
         manylinux: auto
         command: build
-        args: --release --sdist -o dist --find-interpreter --ignore-rust-version
+        args: --release --sdist -o dist --find-interpreter
 
     - name: Upload wheels
       uses: actions/upload-artifact@v3
@@ -31,7 +31,7 @@ jobs:
     - uses: PyO3/maturin-action@v1
       with:
         command: build
-        args: --release -o dist --find-interpreter --ignore-rust-version
+        args: --release -o dist --find-interpreter
     - name: Upload wheels
       uses: actions/upload-artifact@v3
       with:

.pre-commit-config.yaml

@@ -1,18 +1,25 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v3.2.0
-  hooks:
-  - id: trailing-whitespace
-  - id: end-of-file-fixer
-  - id: check-yaml
-  - id: check-added-large-files
-- repo: https://github.com/psf/black
-  rev: 22.10.0
-  hooks:
-  - id: black
-- repo: https://github.com/pycqa/isort
-  rev: 5.10.1
-  hooks:
-    - id: isort
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        name: isort (python)
+        args: [--profile, black]
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    # Ruff version.
+    rev: "v0.0.260"
+    hooks:
+      - id: ruff

README.md

@@ -78,10 +78,30 @@ pip install maturin
 maturin build
 ```
 
-## Contribution
+### Development
 
-Contribution and merge requests by the community are welcome!
+Local development through pip or maturin.
+
+```sh
+cd lightguide
+pip3 install .[dev]
+```
+
+or
+
+```sh
+cd lightguide
+maturin develop
+```
+
+The project utilizes pre-commit for clean commits, install the hooks via:
+
+```sh
+pre-commit install
+```
 
 ## License
 
+Contribution and merge requests by the community are welcome!
+
 Lightguide was written by Marius Paul Isken and is licensed under the GNU GENERAL PUBLIC LICENSE v3.

lightguide/afk_filter_python.py

@@ -1,15 +1,12 @@
 from __future__ import annotations
 
 from functools import lru_cache
-from pathlib import Path
 
 import numpy as np
-import numpy.typing as npt
 
 
 @lru_cache
-def triangular_taper_python(size: int, plateau: int) -> npt.NDArray:
-
+def triangular_taper_python(size: int, plateau: int) -> np.ndarray:
     if plateau > size:
         raise ValueError("Plateau cannot be larger than size.")
     if size % 2 or plateau % 2:
@@ -24,16 +21,18 @@ def triangular_taper_python(size: int, plateau: int) -> npt.NDArray:
 
 
 def afk_filter_python(
-    data: npt.NDArray,
+    data: np.ndarray,
     window_size: int = 32,
     overlap: int = 14,
     exponent: float = 0.3,
     normalize_power: bool = False,
-) -> npt.NDArray:
-    if np.log2(window_size) % 1.0 or window_size < 4:
-        raise ValueError("window_size has to be pow(2) and > 4.")
+) -> np.ndarray:
+    if np.log2(window_size) % 1 or window_size < 4:
+        raise ValueError(f"Window size {window_size} be pow(2) and > 4.")
     if overlap > window_size / 2 - 1:
-        raise ValueError("Overlap is too large. Maximum overlap: window_size / 2 - 1.")
+        raise ValueError(
+            f"Overlap {overlap} is too large. Maximum overlap: window_size / 2 - 1."
+        )
 
     window_stride = window_size - overlap
     window_non_overlap = window_size - 2 * overlap