modusa 0.4.28__py3-none-any.whl → 0.4.30__py3-none-any.whl

modusa/devtools/main.py

@@ -1,45 +0,0 @@
-#!/usr/bin/env python3
-
-
-from .generate_template import TemplateGenerator
-from .generate_docs_source import generate_docs_source
-from .list_plugins import list_plugins
-from . import list_authors
-
-import argparse
-import sys
-
-def main():
-	try:
-		parser = argparse.ArgumentParser(
-			prog="modusa-dev",
-			description="Modusa CLI Tools"
-		)
-		subparsers = parser.add_subparsers(dest="group", required=True)
-		
-		# --- CREATE group ---
-		create_parser = subparsers.add_parser("create", help="Create new Modusa components")
-		create_subparsers = create_parser.add_subparsers(dest="what", required=True)
-		
-		create_subparsers.add_parser("tool", help="Create a new tool class").set_defaults(func=lambda:TemplateGenerator.create_template("tool"))
-		create_subparsers.add_parser("plugin", help="Create a new plugin class").set_defaults(func=lambda:TemplateGenerator.create_template("plugin"))
-		create_subparsers.add_parser("model", help="Create a new model class").set_defaults(func=lambda:TemplateGenerator.create_template("model"))
-		create_subparsers.add_parser("generator", help="Create a new signal generator class").set_defaults(func=lambda:TemplateGenerator.create_template("generator"))
-		create_subparsers.add_parser("io", help="Create a new IO class").set_defaults(func=lambda:TemplateGenerator.create_template("io"))
-		create_subparsers.add_parser("docs", help="Generate the docs").set_defaults(func=lambda:generate_docs_source())
-		
-		# --- LIST group ---
-		list_parser = subparsers.add_parser("list", help="List information about Modusa components")
-		list_subparsers = list_parser.add_subparsers(dest="what", required=True)
-		
-		list_subparsers.add_parser("plugins", help="List available plugins").set_defaults(func=list_plugins)
-		list_subparsers.add_parser("authors", help="List plugin authors").set_defaults(func=list_authors)
-		
-		# --- Parse and execute ---
-		args = parser.parse_args()
-		args.func()
-		
-	except KeyboardInterrupt:
-		print("\n❌ Aborted by user.")
-		sys.exit(1)
-		

modusa/devtools/templates/generator.py

@@ -1,24 +0,0 @@
-#!/usr/bin/env python3
-
-
-from modusa import excp
-from modusa.decorators import validate_args_type
-from modusa.generators.base import ModusaGenerator
-
-
-class {class_name}(ModusaGenerator):
-	"""
-
-	"""
-	
-	#--------Meta Information----------
-	_name = ""
-	_description = ""
-	_author_name = "{author_name}"
-	_author_email = "{author_email}"
-	_created_at = "{date_created}"
-	#----------------------------------
-	
-	def __init__(self):
-		super().__init__()
-	

modusa/devtools/templates/io.py

@@ -1,24 +0,0 @@
-#!/usr/bin/env python3
-
-
-from modusa import excp
-from modusa.decorators import validate_args_type
-from modusa.io.base import ModusaIO
-
-
-class {class_name}(ModusaIO):
-	"""
-
-	"""
-	
-	#--------Meta Information----------
-	_name = ""
-	_description = ""
-	_author_name = "{author_name}"
-	_author_email = "{author_email}"
-	_created_at = "{date_created}"
-	#----------------------------------
-	
-	
-
-	

modusa/devtools/templates/model.py

@@ -1,47 +0,0 @@
-#!/usr/bin/env python3
-
-
-from modusa import excp
-from modusa.decorators import immutable_property, validate_args_type
-from modusa.signals.base import ?
-from typing import Self, Any
-import numpy as np
-
-class {class_name}():
-	"""
-
-	"""
-	
-	#--------Meta Information----------
-	_name = ""
-	_nickname = "" # This is to be used in repr/str methods
-	_description = ""
-	_author_name = "{author_name}"
-	_author_email = "{author_email}"
-	_created_at = "{date_created}"
-	#----------------------------------
-	
-	@validate_args_type()
-	def __init__(self):
-		super().__init__() # Instantiating `ModusaSignal` class
-	
-		self.title = "" # This title will be used as plot title by default
-		
-	#-----------------------------------
-	# Properties
-	#-----------------------------------
-		
-		
-	#===================================
-		
-		
-		
-		
-		
-		
-	#-----------------------------------
-	# Tools
-	#-----------------------------------
-		
-		
-	#===================================

modusa/devtools/templates/plugin.py

@@ -1,41 +0,0 @@
-#!/usr/bin/env python3
-
-
-from modusa import excp
-from modusa.decorators import immutable_property, validate_args_type, plugin_safety_check
-from modusa.plugins.base import ModusaPlugin
-
-
-class {class_name}(ModusaPlugin):
-	"""
-
-	"""
-	
-	#--------Meta Information----------
-	_name = ""
-	_description = ""
-	_author_name = "{author_name}"
-	_author_email = "{author_email}"
-	_created_at = "{date_created}"
-	#----------------------------------
-	
-	def __init__(self):
-		super().__init__()
-		
-	@immutable_property(error_msg="Mutation not allowed.")
-	def allowed_input_signal_types(self) -> tuple[type, ...]:
-		return ()
-	
-	
-	@immutable_property(error_msg="Mutation not allowed.")
-	def allowed_output_signal_types(self) -> tuple[type, ...]:
-		return ()
-	
-	
-	@plugin_safety_check()
-	@validate_args_type()
-	def apply(self, signal: "") -> "":
-		
-		# Run the engine here
-		
-		return 

modusa/devtools/templates/test.py

@@ -1,10 +0,0 @@
-#!/usr/bin/env python3
-
-from modusa import excp
-
-#--------Meta Information----------
-_class_name = "{class_name}"
-_author_name = "{author_name}"
-_author_email = "{author_email}"
-_created_at = "{date_created}"
-#----------------------------------

modusa/devtools/templates/tool.py

@@ -1,24 +0,0 @@
-#!/usr/bin/env python3
-
-
-from modusa import excp
-from modusa.decorators import validate_args_type
-from modusa.tools.base import ModusaTool
-
-
-class {class_name}(ModusaTool):
-	"""
-	
-	"""
-	
-	#--------Meta Information----------
-	_name = ""
-	_description = ""
-	_author_name = "{author_name}"
-	_author_email = "{author_email}"
-	_created_at = "{date_created}"
-	#----------------------------------
-	
-	def __init__(self):
-		super().__init__()
-	

modusa/generators/__init__.py

@@ -1,13 +0,0 @@
-#!/usr/bin/env python3
-
-from .base import ModusaGenerator
-
-from .s_ax import SAxGen
-from .t_ax import TAxGen
-
-from .s1d import S1DGen
-from .tds import TDSGen
-from .audio import AudioGen
-
-from .s2d import S2DGen
-from .ftds import FTDSGen

modusa/generators/audio.py

@@ -1,188 +0,0 @@
-#!/usr/bin/env python3
-
-
-from modusa import excp
-from modusa.decorators import validate_args_type
-from .base import ModusaGenerator
-from modusa.models.t_ax import TAx
-from modusa.models.audio import Audio
-from modusa.models.data import Data
-import numpy as np
-from pathlib import Path
-
-class AudioGen(ModusaGenerator):
-	"""
-	Provides user friendly APIs to generate instances of different 
-	`AudioSignal` instances.
-	"""
-	
-	#--------Meta Information----------
-	_name = ""
-	_description = ""
-	_author_name = "Ankit Anand"
-	_author_email = "ankit0.anand0@gmail.com"
-	_created_at = "2025-07-27"
-	#----------------------------------
-	
-	@staticmethod
-	def from_array(
-		y: np.ndarray,
-		sr: float | int = 1.0,
-		t0: float | int = 0.0,
-		y_label: str = "Amplitude",
-		t_label: str = "Time (sec)",
-		title: str = "Audio Signal"
-	) -> Audio:
-		"""
-		Create `AudioSignal` instance from basic data structures.
-
-		.. code-block:: python
-
-			import modusa as ms
-			t = ms.tds.from_array([1, 2, 3])
-			print(t)
-			t.print_info()
-		
-		Parameters
-		----------
-		y: np.ndarray
-			- Audio data array.
-		sr: float | int
-			- Sampling rate.
-		t0: float | int
-			- Start timestamp.
-		y_label: str
-			- Y label for the signal.
-			- Default: "Y"
-		t_label: str
-			- T label for the signal.
-			- Default: "Time (sec)"
-		title: str
-			- Title for the signal.
-			- Default: "1D Signal"
-		Returns
-		-------
-		Audio
-			An instance of Audio.
-		"""
-		assert isinstance(y, np.ndarray)
-		assert isinstance(sr, (int, float)) and isinstance(t0, (int, float))
-		assert isinstance(y_label, str) and isinstance(t_label, str) and isinstance(title, str)
-		
-		assert y.ndim == 1
-		
-		sr = float(sr)
-		t0 = float(t0)
-		
-		t = TAx(n_points=y.shape[0], sr=sr, t0=t0, label=t_label) # Creating a signal axis instance
-		y = Data(values=y, label=y_label)
-		
-		return Audio(y=y, t=t, title=title)
-	
-	@classmethod
-	def from_youtube(cls, url: str, sr: int | float = None):
-		"""
-		Loads audio from youtube at a given sr.
-		The audio is deleted from the device
-		after loading.
-		
-		.. code-block:: python
-			
-			import modusa as ms
-			audio = ms.audio.from_youtube(
-				url="https://www.youtube.com/watch?v=lIpw9-Y_N0g", 
-				sr=None
-			)
-
-		PARAMETERS
-		----------
-		url: str
-			Link to the YouTube video.
-		sr: int
-			Sampling rate to load the audio in.
-		
-		Returns
-		-------
-		Audio:
-			An `Audio` instance with loaded audio content from YouTube.
-		"""
-		
-		from modusa.tools.youtube_downloader import YoutubeDownloader
-		from modusa import convert
-		import soundfile as sf
-		from scipy.signal import resample
-		import tempfile
-		
-		# Download the audio in temp directory using tempfile module
-		with tempfile.TemporaryDirectory() as tmpdir:
-			audio_fp: Path = YoutubeDownloader.download(url=url, content_type="audio", output_dir=Path(tmpdir))
-			
-			# Convert the audio to ".wav" form for loading
-			wav_audio_fp: Path = convert(inp_audio_fp=audio_fp, output_audio_fp=audio_fp.with_suffix(".wav"))
-			
-			# Load the audio in memory
-			audio_data, audio_sr = sf.read(wav_audio_fp)
-			
-			# Convert to mono if it's multi-channel
-			if audio_data.ndim > 1:
-				audio_data = audio_data.mean(axis=1)
-				
-			# Resample if needed
-			if sr is not None:
-				if audio_sr != sr:
-					n_samples = int(len(audio_data) * sr / audio_sr)
-					audio_data = resample(audio_data, n_samples)
-					audio_sr = sr
-					
-		audio = cls.from_array(y=audio_data, sr=audio_sr, title=audio_fp.stem)
-		
-		return audio
-	
-	@classmethod
-	def from_filepath(cls, fp: str | Path, sr: int | float = None):
-		"""
-		Loads audio from filepath at a given sr.
-		
-		.. code-block:: python
-			
-			import modusa as ms
-			audio = ms.audio.from_filepath(
-				fp="path/to/audio.wav",
-				sr=None
-			)
-
-		PARAMETERS
-		----------
-		fp: str | Path
-			Audio file path.
-		sr: int
-			Sampling rate to load the audio in.
-		
-		Returns
-		-------
-		Audio:
-			An `Audio` instance with loaded audio content.
-		"""
-		import soundfile as sf
-		from scipy.signal import resample
-		from pathlib import Path
-		
-		fp = Path(fp)
-		# Load the audio in memory
-		audio_data, audio_sr = sf.read(fp)
-		
-		# Convert to mono if it's multi-channel
-		if audio_data.ndim > 1:
-			audio_data = audio_data.mean(axis=1)
-			
-		# Resample if needed
-		if sr is not None:
-			if audio_sr != sr:
-				n_samples = int(len(audio_data) * sr / audio_sr)
-				audio_data = resample(audio_data, n_samples)
-				audio_sr = sr
-				
-		audio = cls.from_array(y=audio_data, sr=audio_sr, title=fp.stem)
-		
-		return audio
-	

modusa/generators/audio_waveforms.py

@@ -1,236 +0,0 @@
-#!/usr/bin/env python3
-
-
-from modusa import excp
-from modusa.decorators import validate_args_type
-from modusa.generators.base import ModusaGenerator
-from modusa.models.audio_signal import AudioSignal
-import numpy as np
-
-class AudioWaveformGenerator(ModusaGenerator):
-	"""
-	Generates different kinds of audio waveforms particulary helpful
-	in teaching signal processing concepts and testing out newly
-	created tools.
-	"""
-	
-	#--------Meta Information----------
-	_name = "Audio Waveform Generator"
-	_description = "Generates different kind of audio waveforms."
-	_author_name = "Ankit Anand"
-	_author_email = "ankit0.anand0@gmail.com"
-	_created_at = "2025-07-07"
-	#----------------------------------
-	
-	@staticmethod
-	def generate_example() -> "AudioSignal":
-		"""
-		Generates a simple sine wave audio signal as an example.
-	
-		Returns
-		-------
-		AudioSignal
-			A 600 Hz sine wave lasting 2 seconds, sampled at 10,000 Hz.
-		"""
-		
-		sr = 10000 # Hz
-		duration = 2 # sec
-		freq = 600 # Hz
-		
-		t = np.arange(0, duration, 1 / sr)
-		y = np.sin(2 * np.pi * freq * t)
-		
-		signal = AudioSignal(y=y, sr=sr, title="Example")  # assuming AudioSignal accepts y and t
-		
-		return signal
-	
-	
-	@staticmethod
-	def generate_random(duration: float = 1.0, sr: int = 10000) -> "AudioSignal":
-		"""
-		Generates a random audio signal of given duration and sample rate.
-	
-		Parameters
-		----------
-		duration : float, optional
-			Duration of the signal in seconds (default is 1.0).
-		sr : int, optional
-			Sampling rate in Hz (default is 10,000).
-	
-		Returns
-		-------
-		AudioSignal
-			A randomly generated signal of the specified duration and sample rate.
-		"""
-		num_samples = int(duration * sr)
-		t = np.linspace(0, duration, num=num_samples, endpoint=False)
-		y = np.random.uniform(low=-1.0, high=1.0, size=num_samples)  # use uniform [-1, 1] for audio-like signal
-		
-		signal = AudioSignal(y=y, t=t, title="Random")
-		
-		return signal
-	
-	@staticmethod
-	@validate_args_type()
-	def generate_sinusoid(
-		A: float | int = 1.0,
-		f: float | int = 10.0,
-		phi: float | int = 0.0,
-		duration: float | int = 1.0,
-		sr: int = 1000,
-	) -> "AudioSignal":
-		"""
-		Generates a sinusoid audio signal with specified
-		amplitude, frequency, phase, duration, and sample rate.
-	
-		Parameters
-		----------
-		A : float
-			Amplitude of the sinusoid (default: 1.0)
-		f : float
-			Frequency in Hz (default: 10.0)
-		phi : float
-			Phase in radians (default: 0.0)
-		duration : float
-			Duration of the signal in seconds (default: 1.0)
-		sr : int
-			Sampling rate in Hz (default: 1000)
-	
-		Returns
-		-------
-		AudioSignal
-			A sinusoidal signal with the given parameters.
-		"""
-		A, f, phi, duration, sr = float(A), float(f), float(phi), float(duration), int(sr)
-		
-		t = np.arange(0, duration, 1 / sr)
-		y = A * np.sin(2 * np.pi * f * t + phi)
-		
-		signal = AudioSignal(y=y, sr=sr, title=f"Sinusoid ({f} Hz)")
-		
-		return signal
-	
-	@staticmethod
-	@validate_args_type()
-	def generate_square(
-		A: float | int = 1.0,
-		f: float | int = 10.0,
-		phi: float | int = 0.0,
-		duration: float | int = 1.0,
-		sr: int = 1000,
-	) -> "AudioSignal":
-		"""
-		Generates a square wave audio signal with specified
-		amplitude, frequency, phase, duration, and sample rate.
-	
-		Parameters
-		----------
-		A : float
-			Amplitude of the square wave (default: 1.0)
-		f : float
-			Frequency in Hz (default: 10.0)
-		phi : float
-			Phase in radians (default: 0.0)
-		duration : float
-			Duration of the signal in seconds (default: 1.0)
-		sr : int
-			Sampling rate in Hz (default: 1000)
-	
-		Returns
-		-------
-		AudioSignal
-			A square wave signal of the specified parameters.
-		"""
-		A, f, phi, duration, sr = float(A), float(f), float(phi), float(duration), int(sr)
-		t = np.arange(0, duration, 1 / sr)
-		
-		y = A * np.sign(np.sin(2 * np.pi * f * t + phi))
-		
-		signal = AudioSignal(y=y, sr=sr, title=f"Square ({f} Hz)")
-		
-		return signal
-	
-	
-	@staticmethod
-	@validate_args_type()
-	def generate_sawtooth(
-		A: float | int = 1.0,
-		f: float | int = 10.0,
-		phi: float | int = 0.0,
-		duration: float | int = 1.0,
-		sr: int = 1000,
-	) -> "AudioSignal":
-		"""
-		Generates a sawtooth wave AudioSignal with specified amplitude, frequency, phase, duration, and sample rate.
-	
-		Parameters
-		----------
-		A : float
-			Amplitude of the sawtooth wave (default: 1.0)
-		f : float
-			Frequency in Hz (default: 10.0)
-		phi : float
-			Phase in radians (default: 0.0)
-		duration : float
-			Duration of the signal in seconds (default: 1.0)
-		sr : int
-			Sampling rate in Hz (default: 1000)
-	
-		Returns
-		-------
-		AudioSignal
-			A sawtooth wave signal of the specified parameters.
-		"""
-		A, f, phi, duration, sr = float(A), float(f), float(phi), float(duration), int(sr)
-		t = np.arange(0, duration, 1 / sr)
-		
-		# Convert phase from radians to fractional cycle offset
-		phase_offset = phi / (2 * np.pi)
-		y = A * (2 * ((f * t + phase_offset) % 1) - 1)
-		
-		signal = AudioSignal(y=y, sr=sr, title=f"Sawtooth ({f} Hz)")
-		return signal
-	
-	
-	@staticmethod
-	@validate_args_type()
-	def generate_triangle(
-		A: float | int = 1.0,
-		f: float | int = 10.0,
-		phi: float | int = 0.0,
-		duration: float | int = 1.0,
-		sr: int = 1000,
-	) -> "AudioSignal":
-		"""
-		Generates a triangle wave AudioSignal with specified
-		amplitude, frequency, phase, duration, and sample rate.
-	
-		Parameters
-		----------
-		A : float
-			Amplitude of the triangle wave (default: 1.0)
-		f : float
-			Frequency in Hz (default: 10.0)
-		phi : float
-			Phase in radians (default: 0.0)
-		duration : float
-			Duration of the signal in seconds (default: 1.0)
-		sr : int
-			Sampling rate in Hz (default: 1000)
-	
-		Returns
-		-------
-		AudioSignal
-			A triangle wave signal of the specified parameters.
-		"""
-		A, f, phi, duration, sr = float(A), float(f), float(phi), float(duration), int(sr)
-		t = np.arange(0, duration, 1 / sr)
-		phase_offset = phi / (2 * np.pi)  # Convert radians to cycle offset
-		
-		# Triangle wave formula: 2 * abs(2 * frac(x) - 1) - 1 scaled to amplitude
-		y = A * (2 * np.abs(2 * ((f * t + phase_offset) % 1) - 1) - 1)
-		
-		signal = AudioSignal(y=y, sr=sr, title=f"Triangle ({f} Hz)")
-		
-		return signal
-	

modusa/generators/base.py

@@ -1,29 +0,0 @@
-#!/usr/bin/env python3
-
-from modusa import excp
-from modusa.decorators import validate_args_type, immutable_property
-from modusa.models.base import ModusaSignal
-from abc import ABC, abstractmethod
-from typing import Any
-
-class ModusaGenerator(ABC):
-	"""
-	Base class for any type of signal generators for modusa framework.
-	
-	Note
-	----
-	- This class is intended to be subclassed by any Generator related tools built for the modusa framework.
-	- In order to create a generator tool, you can use modusa-dev CLI to generate an generator template.
-	- It is recommended to treat subclasses of ModusaGenerator as namespaces and define @staticmethods with control parameters, rather than using instance-level __init__ methods.
-	
-	
-	"""
-	
-	#--------Meta Information----------
-	_name = ""
-	_description = ""
-	_author_name = "Ankit Anand"
-	_author_email = "ankit0.anand0@gmail.com"
-	_created_at = "2025-07-04"
-	#----------------------------------
-