added standard header to .py files

shaketune/commands/__init__.py

@@ -1,3 +1,12 @@
+# Shake&Tune: 3D printer analysis tools
+#
+# Copyright (C) 2024 Félix Boisselier <felix@fboisselier.fr> (Frix_x on Discord)
+# Licensed under the GNU General Public License v3.0 (GPL-3.0)
+#
+# File: __init__.py
+# Description: Imports various commands function (to run and record the tests) for the Shake&Tune package.
+
+
 from .axes_map_calibration import axes_map_calibration as axes_map_calibration
 from .axes_shaper_calibration import axes_shaper_calibration as axes_shaper_calibration
 from .compare_belts_responses import compare_belts_responses as compare_belts_responses

shaketune/commands/accelerometer.py

@@ -1,6 +1,13 @@
-# This file provides a custom and internal Shake&Tune Accelerometer helper that is
-# an interface to Klipper's own accelerometer classes. It is used to start and
-# stop accelerometer measurements and write the data to a file in a blocking manner.
+# Shake&Tune: 3D printer analysis tools
+#
+# Copyright (C) 2024 Félix Boisselier <felix@fboisselier.fr> (Frix_x on Discord)
+# Licensed under the GNU General Public License v3.0 (GPL-3.0)
+#
+# File: accelerometer.py
+# Description: Provides a custom and internal Shake&Tune Accelerometer helper that interfaces
+#              with Klipper's accelerometer classes. It includes functions to start and stop
+#              accelerometer measurements and write the data to a file in a blocking manner.
+
 
 import time
 

shaketune/commands/axes_map_calibration.py

@@ -1,3 +1,14 @@
+# Shake&Tune: 3D printer analysis tools
+#
+# Copyright (C) 2024 Félix Boisselier <felix@fboisselier.fr> (Frix_x on Discord)
+# Licensed under the GNU General Public License v3.0 (GPL-3.0)
+#
+# File: axes_map_calibration.py
+# Description: Provides a command for calibrating the axes map of a 3D printer using an accelerometer.
+#              The script moves the printer head along specified axes, starts and stops measurements,
+#              and performs post-processing to analyze the collected data.
+
+
 from ..helpers.console_output import ConsoleOutput
 from ..shaketune_process import ShakeTuneProcess
 from .accelerometer import Accelerometer

shaketune/commands/axes_shaper_calibration.py

@@ -1,3 +1,14 @@
+# Shake&Tune: 3D printer analysis tools
+#
+# Copyright (C) 2024 Félix Boisselier <felix@fboisselier.fr> (Frix_x on Discord)
+# Licensed under the GNU General Public License v3.0 (GPL-3.0)
+#
+# File: axes_shaper_calibration.py
+# Description: Provides a command for calibrating the input shaper of a 3D printer's axes using an accelerometer.
+#              The script performs resonance tests along specified axes, starts and stops measurements,
+#              and generates graphs for each axis to analyze the collected data.
+
+
 from ..helpers.common_func import AXIS_CONFIG
 from ..helpers.console_output import ConsoleOutput
 from ..helpers.resonance_test import vibrate_axis

shaketune/commands/compare_belts_responses.py

@@ -1,3 +1,14 @@
+# Shake&Tune: 3D printer analysis tools
+#
+# Copyright (C) 2024 Félix Boisselier <felix@fboisselier.fr> (Frix_x on Discord)
+# Licensed under the GNU General Public License v3.0 (GPL-3.0)
+#
+# File: compare_belts_responses.py
+# Description: Provides a command for comparing the frequency response of belts in CoreXY and CoreXZ kinematics 3D printers.
+#              The script performs resonance tests along specified axes, starts and stops measurements, and generates graphs
+#              for each axis to analyze the collected data.
+
+
 from ..helpers.common_func import AXIS_CONFIG
 from ..helpers.console_output import ConsoleOutput
 from ..helpers.motors_config_parser import MotorsConfigParser

shaketune/commands/create_vibrations_profile.py

@@ -1,3 +1,14 @@
+# Shake&Tune: 3D printer analysis tools
+#
+# Copyright (C) 2024 Félix Boisselier <felix@fboisselier.fr> (Frix_x on Discord)
+# Licensed under the GNU General Public License v3.0 (GPL-3.0)
+#
+# File: vibrations_profile.py
+# Description: Provides a command to measure the vibrations generated by the kinematics and motors of a 3D printers
+#              at different speeds and angles increments. The data is collected from the accelerometer and used
+#              to generate a comprehensive vibration analysis graph.
+
+
 import math
 
 from ..helpers.console_output import ConsoleOutput

shaketune/commands/excitate_axis_at_freq.py

@@ -1,3 +1,13 @@
+# Shake&Tune: 3D printer analysis tools
+#
+# Copyright (C) 2024 Félix Boisselier <felix@fboisselier.fr> (Frix_x on Discord)
+# Licensed under the GNU General Public License v3.0 (GPL-3.0)
+#
+# File: excitate_axis_at_freq.py
+# Description: Provide a command to excites a specified axis at a given frequency for a duration
+#              and optionally creates a graph of the vibration data collected by the accelerometer.
+
+
 from ..helpers.common_func import AXIS_CONFIG
 from ..helpers.console_output import ConsoleOutput
 from ..helpers.resonance_test import vibrate_axis_at_static_freq