From cb1c787b437203962e07f4542621a4f140e6869b Mon Sep 17 00:00:00 2001 From: Thijs Driessen Date: Wed, 19 Nov 2025 15:56:03 +0100 Subject: [PATCH] better structure --- .idea/.gitignore | 8 ++++++++ .idea/A.K.03.iml | 14 ++++++++++++++ .idea/inspectionProfiles/profiles_settings.xml | 6 ++++++ .idea/misc.xml | 7 +++++++ .idea/modules.xml | 8 ++++++++ .idea/vcs.xml | 6 ++++++ .../0_Table_of_Contents.ipynb | 4 ++-- .../1_Introduction.ipynb | 2 +- 2_Module_0.ipynb => Manual/2_Module_0.ipynb | 6 +++--- 3_Module_1.ipynb => Manual/3_Module_1.ipynb | 2 +- 4_Module_2.ipynb => Manual/4_Module_2.ipynb | 2 +- 5_Module_3.ipynb => Manual/5_Module_3.ipynb | 6 +++--- 6_Module_4.ipynb => Manual/6_Module_4.ipynb | 2 +- .../7_Midterm_Report.ipynb | 2 +- 8_Module_5.ipynb => Manual/8_Module_5.ipynb | 4 ++-- README.md | 1 - student-code | 1 - {Student Code => student_code}/control.py | 0 student_code/distance_sensor.py | 0 19 files changed, 64 insertions(+), 17 deletions(-) create mode 100644 .idea/.gitignore create mode 100644 .idea/A.K.03.iml create mode 100644 .idea/inspectionProfiles/profiles_settings.xml create mode 100644 .idea/misc.xml create mode 100644 .idea/modules.xml create mode 100644 .idea/vcs.xml rename 0_Table_of_Contents.ipynb => Manual/0_Table_of_Contents.ipynb (90%) rename 1_Introduction.ipynb => Manual/1_Introduction.ipynb (99%) rename 2_Module_0.ipynb => Manual/2_Module_0.ipynb (99%) rename 3_Module_1.ipynb => Manual/3_Module_1.ipynb (99%) rename 4_Module_2.ipynb => Manual/4_Module_2.ipynb (99%) rename 5_Module_3.ipynb => Manual/5_Module_3.ipynb (98%) rename 6_Module_4.ipynb => Manual/6_Module_4.ipynb (99%) rename 7_Midterm_Report.ipynb => Manual/7_Midterm_Report.ipynb (99%) rename 8_Module_5.ipynb => Manual/8_Module_5.ipynb (99%) delete mode 100644 README.md delete mode 160000 student-code rename {Student Code => student_code}/control.py (100%) create mode 100644 student_code/distance_sensor.py diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..13566b8 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/A.K.03.iml b/.idea/A.K.03.iml new file mode 100644 index 0000000..c56ca50 --- /dev/null +++ b/.idea/A.K.03.iml @@ -0,0 +1,14 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml new file mode 100644 index 0000000..105ce2d --- /dev/null +++ b/.idea/inspectionProfiles/profiles_settings.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..822c310 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,7 @@ + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..6738b06 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/0_Table_of_Contents.ipynb b/Manual/0_Table_of_Contents.ipynb similarity index 90% rename from 0_Table_of_Contents.ipynb rename to Manual/0_Table_of_Contents.ipynb index 1e21f50..0eea8e6 100644 --- a/0_Table_of_Contents.ipynb +++ b/Manual/0_Table_of_Contents.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "![book header](pictures/header.png)\n", + "![book header](../pictures/header.png)\n", "# Table of Contents\n", "\n", "\n", @@ -28,7 +28,7 @@ "\n", "Appendix B: [Serial Communication with Windows](appendix/Appendix_B.md)\n", "\n", - "Appendix C: [TDOA Localization Algorithm](appendix/Appendix_C.ipynb)\n" + "Appendix C: [TDOA Localization Algorithm](../appendix/Appendix_C.ipynb)\n" ] }, { diff --git a/1_Introduction.ipynb b/Manual/1_Introduction.ipynb similarity index 99% rename from 1_Introduction.ipynb rename to Manual/1_Introduction.ipynb index dc60ccc..3835bf6 100644 --- a/1_Introduction.ipynb +++ b/Manual/1_Introduction.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "![book header](pictures/header.png)\n", + "![book header](../pictures/header.png)\n", "\n", "[Table of Contents](0_Table_of_Contents.ipynb)" ] diff --git a/2_Module_0.ipynb b/Manual/2_Module_0.ipynb similarity index 99% rename from 2_Module_0.ipynb rename to Manual/2_Module_0.ipynb index ccc5b73..1113665 100644 --- a/2_Module_0.ipynb +++ b/Manual/2_Module_0.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "![book header](pictures/header.png)\n", + "![book header](../pictures/header.png)\n", "[Table of Contents](0_Table_of_Contents.ipynb)" ] }, @@ -30,8 +30,8 @@ "## Initial software Installation\n", "Before we can start doing anything, you need to set up your programming environment in Python. We have provided a step by step guide that walks you through installing Python, Visual Studio Code, and all the necessary dependencies for your project. You can find them here:\n", "\n", - "1. [Installation Mac](appendix/0_Installation_Mac.ipynb)\n", - "2. [Installation Windows](appendix/0_Installation_Windows.ipynb)" + "1. [Installation Mac](../appendix/0_Installation_Mac.ipynb)\n", + "2. [Installation Windows](../appendix/0_Installation_Windows.ipynb)" ] }, { diff --git a/3_Module_1.ipynb b/Manual/3_Module_1.ipynb similarity index 99% rename from 3_Module_1.ipynb rename to Manual/3_Module_1.ipynb index 4aad4d5..0a5685c 100644 --- a/3_Module_1.ipynb +++ b/Manual/3_Module_1.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "![book header](pictures/header.png)\n", + "![book header](../pictures/header.png)\n", "\n", "[Table of Contents](0_Table_of_Contents.ipynb)\n", "\n", diff --git a/4_Module_2.ipynb b/Manual/4_Module_2.ipynb similarity index 99% rename from 4_Module_2.ipynb rename to Manual/4_Module_2.ipynb index 95a1431..5bda07e 100644 --- a/4_Module_2.ipynb +++ b/Manual/4_Module_2.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "![book header](pictures/header.png)\n", + "![book header](../pictures/header.png)\n", "\n", "[Table of Contents](0_Table_of_Contents.ipynb)\n", "\n", diff --git a/5_Module_3.ipynb b/Manual/5_Module_3.ipynb similarity index 98% rename from 5_Module_3.ipynb rename to Manual/5_Module_3.ipynb index d91e460..0439802 100644 --- a/5_Module_3.ipynb +++ b/Manual/5_Module_3.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "![book header](pictures/header.png)\n", + "![book header](../pictures/header.png)\n", "\n", "[Table of Contents](0_Table_of_Contents.ipynb)\n", "\n", @@ -314,7 +314,7 @@ "### Student Version ###\n", "\n", "# Load and normalize the reference signal\n", - "Fs_ref, ref_signal = wavfile.read(\"Files/Student Recordings/reference.wav\")\n", + "Fs_ref, ref_signal = wavfile.read(\"../files/Student Recordings/reference.wav\")\n", "ref_signal = ref_signal[221000:222500, 0] # Use only one channel\n", "# TODO: Normalize the reference signal\n", "\n", @@ -638,7 +638,7 @@ "\n", "We offer two approaches for this:\n", "\n", - "1. **Linear Algebra Approach:** Study [Appendix C](appendix/Appendix_C.ipynb), which shows a basic algorithm to solve for $(x, y)$ using linear algebra. This algorithm is sub-optimal but should be relatively fast, and is a nice illustration of the use of linear algebra (for those who appreciate this).\n", + "1. **Linear Algebra Approach:** Study [Appendix C](../appendix/Appendix_C.ipynb), which shows a basic algorithm to solve for $(x, y)$ using linear algebra. This algorithm is sub-optimal but should be relatively fast, and is a nice illustration of the use of linear algebra (for those who appreciate this).\n", "\n", "2. **Grid Search Method:** Perform a grid search over possible $(x, y)$ positions and evaluate which position best matches the estimated TDOAs. This method can be accurate but may be slower depending on implementation. Consider e.g. iterative grid refinement.\n", "\n", diff --git a/6_Module_4.ipynb b/Manual/6_Module_4.ipynb similarity index 99% rename from 6_Module_4.ipynb rename to Manual/6_Module_4.ipynb index 1373989..0724e3c 100644 --- a/6_Module_4.ipynb +++ b/Manual/6_Module_4.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "![book header](pictures/header.png)\n", + "![book header](../pictures/header.png)\n", "\n", "[Table of Contents](0_Table_of_Contents.ipynb)\n", "\n", diff --git a/7_Midterm_Report.ipynb b/Manual/7_Midterm_Report.ipynb similarity index 99% rename from 7_Midterm_Report.ipynb rename to Manual/7_Midterm_Report.ipynb index 5b13478..c9da081 100644 --- a/7_Midterm_Report.ipynb +++ b/Manual/7_Midterm_Report.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "![book header](pictures/header.png)\n", + "![book header](../pictures/header.png)\n", "[Table of Contents](0_Table_of_Contents.ipynb)" ] }, diff --git a/8_Module_5.ipynb b/Manual/8_Module_5.ipynb similarity index 99% rename from 8_Module_5.ipynb rename to Manual/8_Module_5.ipynb index 86520b9..67bf78d 100644 --- a/8_Module_5.ipynb +++ b/Manual/8_Module_5.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "![book header](pictures/header.png)\n", + "![book header](../pictures/header.png)\n", "\n", "[Table of Contents](0_Table_of_Contents.ipynb)\n", "\n", @@ -283,7 +283,7 @@ "\n", "The figure below is a example depiction of the Challenges (*On the old television series, KARR is the archenemy of KITT*)\n", "\n", - "![alt text](pictures/FinalChallenge.png)\n", + "![alt text](../pictures/FinalChallenge.png)\n", "\n", "\n" ] diff --git a/README.md b/README.md deleted file mode 100644 index a29c939..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -# Book \ No newline at end of file diff --git a/student-code b/student-code deleted file mode 160000 index eb982ad..0000000 --- a/student-code +++ /dev/null @@ -1 +0,0 @@ -Subproject commit eb982ad8ab46ed773d72e1e79597b23fc5e2ebba diff --git a/Student Code/control.py b/student_code/control.py similarity index 100% rename from Student Code/control.py rename to student_code/control.py diff --git a/student_code/distance_sensor.py b/student_code/distance_sensor.py new file mode 100644 index 0000000..e69de29