Folder + init + readme

qua-platform · Mar 19, 2024 · 2c100e6 · 2c100e6
1 parent 191bc44
commit 2c100e6
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 0 deletions.
diff --git a/qualang_tools/digital_filters/README.md b/qualang_tools/digital_filters/README.md
@@ -0,0 +1,47 @@
+# Digital filter tools
+This library includes tools for deriving the taps of the OPX digital filters (IIR and FIR). 
+
+## calc_filter_taps
+some explanation
+
+### Usage examples
+
+#### 
+```python
+from qualang_tools.loops import from_array
+
+```
+
+## exponential_correction
+some explanation
+
+### Usage examples
+
+#### 
+```python
+from qualang_tools.loops import from_array
+
+```
+
+## highpass_correction
+some explanation
+
+### Usage examples
+
+#### 
+```python
+from qualang_tools.loops import from_array
+
+```
+
+## bounce_and_delay_correction
+
+some explanation
+
+### Usage examples
+
+#### 
+```python
+from qualang_tools.loops import from_array
+
+```
diff --git a/qualang_tools/digital_filters/__init__.py b/qualang_tools/digital_filters/__init__.py
@@ -0,0 +1,13 @@
+from qualang_tools.digital_filters.filters import (
+    calc_filter_taps,
+    exponential_correction,
+    highpass_correction,
+    bounce_and_delay_correction,
+)
+
+__all__ = [
+    "calc_filter_taps",
+    "exponential_correction",
+    "highpass_correction",
+    "bounce_and_delay_correction",
+]
diff --git a/qualang_tools/filter_tools.py → qualang_tools/digital_filters/filters.py b/qualang_tools/filter_tools.py → qualang_tools/digital_filters/filters.py