commlab 0.2.0__tar.gz

commlab-0.2.0/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.1
+Name: commlab
+Version: 0.2.0
+Summary: Communication Lab utilities for signal processing and noise addition
+Author: Padmapriya C J
+Author-email: padmapriyacj06@gmail.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7

commlab-0.2.0/README.md

@@ -0,0 +1,101 @@
+# CommLab - Communication Laboratory Utilities
+
+A Python package providing utility functions for communication systems experiments and simulations.
+
+## Features
+
+- **AWGN Noise Addition**: Add Additive White Gaussian Noise to signals with specified SNR
+- Supports both real and complex-valued signals
+- Works with multi-dimensional arrays
+- Easy to use and extend
+
+## Installation
+
+### From source (Development mode)
+
+1. Clone or download this repository
+2. Navigate to the package directory
+3. Install in editable mode:
+
+```bash
+pip install -e .
+```
+
+This allows you to modify the source code and see changes immediately without reinstalling.
+
+## Usage
+
+### Basic Example
+
+```python
+import numpy as np
+from commlab import awgn
+
+# Create a simple BPSK signal
+signal = np.array([1, -1, 1, -1, 1, -1])
+
+# Add AWGN with SNR = 10 dB
+noisy_signal = awgn(signal, SNRdb=10)
+```
+
+### QPSK Example
+
+```python
+import numpy as np
+from commlab import awgn
+
+# Create QPSK symbols
+qpsk_symbols = np.array([1+1j, -1+1j, -1-1j, 1-1j]) / np.sqrt(2)
+
+# Add noise with 15 dB SNR
+noisy_qpsk = awgn(qpsk_symbols, SNRdb=15)
+```
+
+### With Oversampling
+
+```python
+import numpy as np
+from commlab import awgn
+
+# Oversampled signal (4 samples per symbol)
+oversampled_signal = np.repeat([1, -1, 1, -1], 4)
+
+# Add noise (L=4 for 4 samples per symbol)
+noisy_signal = awgn(oversampled_signal, SNRdb=10, L=4)
+```
+
+## Function Reference
+
+### `awgn(s, SNRdb, L=1)`
+
+Add Additive White Gaussian Noise to a signal.
+
+**Parameters:**
+- `s` (array_like): Input signal (real or complex)
+- `SNRdb` (float): Signal-to-Noise Ratio in dB
+- `L` (int, optional): Samples per symbol (default=1)
+
+**Returns:**
+- `r` (ndarray): Noisy signal
+
+## Requirements
+
+- Python >= 3.7
+- NumPy >= 1.20.0
+
+## Future Extensions
+
+This package is designed to be easily extensible. Future versions may include:
+- Modulation schemes (BPSK, QPSK, QAM)
+- Demodulation functions
+- BER calculation utilities
+- Eye diagram plotting
+- Channel models
+
+## License
+
+MIT License
+
+## Contributing
+
+Feel free to add more functions as needed for your communication lab experiments!

commlab-0.2.0/commlab/__init__.py

@@ -0,0 +1,24 @@
+"""
+CommLab - Communication Laboratory Utilities
+=============================================
+
+A Python package providing utility functions for communication systems
+experiments and simulations.
+
+Available functions
+-------------------
+awgn : Add Additive White Gaussian Noise to signals
+
+Example usage
+-------------
+>>> from commlab import awgn
+>>> import numpy as np
+>>> 
+>>> signal = np.array([1, -1, 1, -1])
+>>> noisy_signal = awgn(signal, SNRdb=10)
+"""
+
+from .main import awgn
+
+__version__ = '0.1.0'
+__all__ = ['awgn']

commlab-0.2.0/commlab/main.py

@@ -0,0 +1,76 @@
+"""
+Noise generation functions for communication systems.
+"""
+
+import numpy as np
+
+
+def awgn(s, SNRdb, L=1):
+    """
+    Add Additive White Gaussian Noise (AWGN) to a signal.
+    
+    This function adds AWGN to the input signal based on the specified 
+    Signal-to-Noise Ratio (SNR) in dB. It works with both real and 
+    complex-valued signals of any dimension.
+    
+    Parameters
+    ----------
+    s : array_like
+        Input signal (real or complex-valued). Can be 1D or multi-dimensional.
+    SNRdb : float
+        Signal-to-Noise Ratio in decibels (dB).
+    L : int, optional
+        Samples per symbol for oversampled signals (default=1).
+        Used to normalize the signal power calculation.
+    
+    Returns
+    -------
+    r : ndarray
+        Noisy signal with the same shape as input signal s.
+        r = s + n, where n is the generated AWGN.
+    
+    Examples
+    --------
+    >>> import numpy as np
+    >>> from commlab import awgn
+    >>> 
+    >>> # Real signal
+    >>> signal = np.array([1, -1, 1, -1])
+    >>> noisy_signal = awgn(signal, SNRdb=10)
+    >>> 
+    >>> # Complex signal (QPSK)
+    >>> qpsk_signal = np.array([1+1j, -1+1j, -1-1j, 1-1j]) / np.sqrt(2)
+    >>> noisy_qpsk = awgn(qpsk_signal, SNRdb=15)
+    
+    Notes
+    -----
+    The noise power is calculated as N0 = P/gamma, where:
+    - P is the average signal power
+    - gamma is the SNR in linear scale (10^(SNRdb/10))
+    
+    For complex signals, the noise is generated with equal power in 
+    both I and Q components.
+    """
+    # Convert SNR from dB to linear scale
+    gamma = 10**(SNRdb / 10.0)
+    
+    # Calculate average signal power
+    P = L * np.sum(np.abs(s)**2) / s.size
+    
+    # Calculate noise power spectral density
+    N0 = P / gamma
+    
+    # Generate AWGN based on signal type
+    if np.isrealobj(s):
+        # Real-valued signal: generate real Gaussian noise
+        n = np.sqrt(N0 / 2) * np.random.standard_normal(s.shape)
+    else:
+        # Complex-valued signal: generate complex Gaussian noise
+        # with equal power in real and imaginary components
+        n = np.sqrt(N0 / 2) * (
+            np.random.standard_normal(s.shape) + 
+            1j * np.random.standard_normal(s.shape)
+        )
+    
+    # Return noisy signal
+    return s + n

commlab-0.2.0/commlab.egg-info/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.1
+Name: commlab
+Version: 0.2.0
+Summary: Communication Lab utilities for signal processing and noise addition
+Author: Padmapriya C J
+Author-email: padmapriyacj06@gmail.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7

commlab-0.2.0/commlab.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+setup.py
+commlab/__init__.py
+commlab/main.py
+commlab.egg-info/PKG-INFO
+commlab.egg-info/SOURCES.txt
+commlab.egg-info/dependency_links.txt
+commlab.egg-info/requires.txt
+commlab.egg-info/top_level.txt

commlab-0.2.0/commlab.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

commlab-0.2.0/commlab.egg-info/requires.txt

@@ -0,0 +1 @@
+numpy>=1.20.0

commlab-0.2.0/commlab.egg-info/top_level.txt

@@ -0,0 +1 @@
+commlab

commlab-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

commlab-0.2.0/setup.py

@@ -0,0 +1,30 @@
+from setuptools import setup, find_packages
+
+with open("README.md","r") as f:
+    description = f.read()
+
+setup(
+    name='commlab',
+    version='0.2.0',
+    description='Communication Lab utilities for signal processing and noise addition',
+    author='Padmapriya C J',
+    author_email='padmapriyacj06@gmail.com',
+    packages=find_packages(),
+    install_requires=[
+        'numpy>=1.20.0',
+    ],
+    python_requires='>=3.7',
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Science/Research',
+        'Topic :: Scientific/Engineering :: Information Analysis',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+    ],
+)
+long_description=open("README.md").read(),
+long_description_content_type="text/markdown",