From 2c100e6a57005b6869d0268a0e92f6477f2399dd Mon Sep 17 00:00:00 2001
From: TheoQM <theo@quantum-machines.co>
Date: Tue, 19 Mar 2024 11:51:18 +0100
Subject: [PATCH] Folder + init + readme

---
 qualang_tools/digital_filters/README.md       | 47 +++++++++++++++++++
 qualang_tools/digital_filters/__init__.py     | 13 +++++
 .../filters.py}                               |  0
 3 files changed, 60 insertions(+)
 create mode 100644 qualang_tools/digital_filters/README.md
 create mode 100644 qualang_tools/digital_filters/__init__.py
 rename qualang_tools/{filter_tools.py => digital_filters/filters.py} (100%)

diff --git a/qualang_tools/digital_filters/README.md b/qualang_tools/digital_filters/README.md
new file mode 100644
index 00000000..944d1388
--- /dev/null
+++ 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
+
+```
\ No newline at end of file
diff --git a/qualang_tools/digital_filters/__init__.py b/qualang_tools/digital_filters/__init__.py
new file mode 100644
index 00000000..2597191a
--- /dev/null
+++ 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 b/qualang_tools/digital_filters/filters.py
similarity index 100%
rename from qualang_tools/filter_tools.py
rename to qualang_tools/digital_filters/filters.py