phased-array-modeling 1.2.0__tar.gz → 1.3.1__tar.gz

{phased_array_modeling-1.2.0/phased_array_modeling.egg-info → phased_array_modeling-1.3.1}/PKG-INFO

@@ -1,10 +1,11 @@
 Metadata-Version: 2.4
 Name: phased-array-modeling
-Version: 1.2.0
+Version: 1.3.1
 Summary: Comprehensive Python library for phased array antenna modeling and visualization
 Author-email: John Hodge <jah70@vt.edu>
 License: MIT
 Project-URL: Homepage, https://github.com/jman4162/Phased-Array-Antenna-Model
+Project-URL: Documentation, https://phased-array-antenna-model.readthedocs.io/
 Project-URL: Repository, https://github.com/jman4162/Phased-Array-Antenna-Model
 Project-URL: Issues, https://github.com/jman4162/Phased-Array-Antenna-Model/issues
 Keywords: phased array,antenna,beamforming,radar,electromagnetics,array factor,radiation pattern
@@ -37,6 +38,10 @@ Requires-Dist: pytest>=7.0.0; extra == "dev"
 Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
 Requires-Dist: plotly>=5.0.0; extra == "dev"
 Requires-Dist: seaborn>=0.11.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.0.0; extra == "docs"
+Requires-Dist: pydata-sphinx-theme>=0.14.0; extra == "docs"
+Requires-Dist: sphinx-copybutton>=0.5.0; extra == "docs"
 Dynamic: license-file
 
 # Phased Array Antenna Modeling
@@ -48,6 +53,7 @@ Dynamic: license-file
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/jman4162/Phased-Array-Antenna-Model/blob/main/Phased_Array_Demo.ipynb)
 [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://phased-array-antenna-model.streamlit.app/)
+[![Documentation](https://readthedocs.org/projects/phased-array-antenna-model/badge/?version=latest)](https://phased-array-antenna-model.readthedocs.io/en/latest/)
 
 A comprehensive Python library for computing and visualizing phased array antenna radiation patterns. Features **125x faster** vectorized computations, multiple array geometries, advanced beamforming, and interactive 3D visualization.
 
@@ -198,7 +204,15 @@ fig.show()
 
 ## Documentation
 
-For comprehensive documentation, see the [demo notebook](Phased_Array_Demo.ipynb) which covers:
+**[Full Documentation on ReadTheDocs](https://phased-array-antenna-model.readthedocs.io/)** includes:
+
+- **Getting Started**: Installation, quickstart guide, core concepts
+- **User Guides**: Detailed tutorials for geometry, beamforming, impairments, wideband, and visualization
+- **API Reference**: Complete reference for all functions with examples
+- **Cookbook**: Practical recipes for hardware engineers, systems engineers, and researchers
+- **Theory Background**: Mathematical foundations for array analysis
+
+For hands-on learning, see the [demo notebook](Phased_Array_Demo.ipynb) which covers:
 
 1. Basic array factor computation
 2. Beam steering

{phased_array_modeling-1.2.0 → phased_array_modeling-1.3.1}/README.md

@@ -7,6 +7,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/jman4162/Phased-Array-Antenna-Model/blob/main/Phased_Array_Demo.ipynb)
 [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://phased-array-antenna-model.streamlit.app/)
+[![Documentation](https://readthedocs.org/projects/phased-array-antenna-model/badge/?version=latest)](https://phased-array-antenna-model.readthedocs.io/en/latest/)
 
 A comprehensive Python library for computing and visualizing phased array antenna radiation patterns. Features **125x faster** vectorized computations, multiple array geometries, advanced beamforming, and interactive 3D visualization.
 
@@ -157,7 +158,15 @@ fig.show()
 
 ## Documentation
 
-For comprehensive documentation, see the [demo notebook](Phased_Array_Demo.ipynb) which covers:
+**[Full Documentation on ReadTheDocs](https://phased-array-antenna-model.readthedocs.io/)** includes:
+
+- **Getting Started**: Installation, quickstart guide, core concepts
+- **User Guides**: Detailed tutorials for geometry, beamforming, impairments, wideband, and visualization
+- **API Reference**: Complete reference for all functions with examples
+- **Cookbook**: Practical recipes for hardware engineers, systems engineers, and researchers
+- **Theory Background**: Mathematical foundations for array analysis
+
+For hands-on learning, see the [demo notebook](Phased_Array_Demo.ipynb) which covers:
 
 1. Basic array factor computation
 2. Beam steering

{phased_array_modeling-1.2.0 → phased_array_modeling-1.3.1}/phased_array/__init__.py

@@ -32,19 +32,26 @@ Example
 >>> theta, phi, pattern_dB = pa.compute_full_pattern(geom.x, geom.y, weights, k)
 """
 
-__version__ = "1.2.0"
+__version__ = "1.3.1"
 
 # Beamforming functions
-from .beamforming import (  # Amplitude tapers; Null steering; Multiple beams
-    apply_taper_to_geometry, chebyshev_taper_1d, chebyshev_taper_2d,
-    compute_beam_isolation, compute_null_depth, compute_taper_directivity_loss,
-    compute_taper_efficiency, cosine_on_pedestal_taper_1d,
-    cosine_on_pedestal_taper_2d, cosine_taper_1d, cosine_taper_2d,
-    gaussian_taper_1d, gaussian_taper_2d, hamming_taper_1d, hamming_taper_2d,
-    hanning_taper_1d, hanning_taper_2d, monopulse_weights,
+from .beamforming import (  # Amplitude tapers; Null steering; Multiple beams; Beam spoiling; Adaptive
+    adaptive_weights_gsc, adaptive_weights_smi, apply_taper_to_geometry,
+    chebyshev_taper_1d, chebyshev_taper_2d, compute_beam_isolation,
+    compute_null_depth, compute_sinr_improvement, compute_spoil_factor,
+    compute_taper_directivity_loss, compute_taper_efficiency,
+    cosine_on_pedestal_taper_1d, cosine_on_pedestal_taper_2d, cosine_taper_1d,
+    cosine_taper_2d, gaussian_taper_1d, gaussian_taper_2d, hamming_taper_1d,
+    hamming_taper_2d, hanning_taper_1d, hanning_taper_2d, monopulse_weights,
     multi_beam_weights_orthogonal, multi_beam_weights_superposition,
-    null_steering_lcmv, null_steering_projection, taylor_taper_1d,
-    taylor_taper_2d)
+    null_steering_lcmv, null_steering_projection, plot_adapted_pattern,
+    quadratic_phase_spoil, spoiled_beam_gain, spoiled_beamwidth,
+    taylor_taper_1d, taylor_taper_2d)
+# Coordinate transformation functions
+from .coordinates import (antenna_to_cone, antenna_to_radar, cone_to_antenna,
+                          radar_to_antenna, rotate_pattern,
+                          rotation_matrix_pitch, rotation_matrix_roll,
+                          rotation_matrix_yaw)
 # Core computation functions
 from .core import (array_factor_fft, array_factor_uv, array_factor_vectorized,
                    compute_directivity, compute_full_pattern,
@@ -59,21 +66,29 @@ from .export import (export_array_config_json, export_coupling_matrix_csv,
                      export_weights_csv, load_pattern_npz)
 # Geometry classes and functions
 from .geometry import (ArrayGeometry, SubarrayArchitecture,
-                       array_factor_conformal, compute_subarray_weights,
-                       create_circular_array, create_concentric_rings_array,
-                       create_cylindrical_array, create_elliptical_array,
+                       array_factor_conformal, compute_overlapped_pattern,
+                       compute_subarray_weights, create_circular_array,
+                       create_concentric_rings_array, create_cylindrical_array,
+                       create_elliptical_array, create_overlapped_subarrays,
                        create_rectangular_array, create_rectangular_subarrays,
                        create_spherical_array, create_triangular_array,
-                       thin_array_density_tapered,
+                       overlapped_subarray_weights, thin_array_density_tapered,
                        thin_array_genetic_algorithm, thin_array_random)
 # Impairment models
-from .impairments import (  # Mutual coupling; Phase quantization; Element failures; Scan blindness
-    active_element_pattern, analyze_graceful_degradation,
+from .impairments import (  # Mutual coupling; Phase quantization; Element failures; Scan blindness; Active impedance
+    active_element_pattern, active_impedance, active_reflection_coefficient,
+    active_scan_impedance_matrix, analyze_graceful_degradation,
     analyze_quantization_effect, apply_mutual_coupling, apply_scan_blindness,
-    compute_scan_loss, mutual_coupling_matrix_measured,
+    compute_scan_loss, mismatch_loss, mutual_coupling_matrix_measured,
     mutual_coupling_matrix_theoretical, quantization_rms_error,
     quantization_sidelobe_increase, quantize_phase, scan_blindness_model,
-    simulate_element_failures, surface_wave_scan_angle)
+    simulate_element_failures, surface_wave_scan_angle, vswr_vs_scan)
+# Polarization functions
+from .polarization import (axial_ratio, co_pol_pattern,
+                           cross_pol_discrimination, cross_pol_pattern,
+                           jones_vector, ludwig3_decomposition,
+                           polarization_loss_factor, stokes_parameters,
+                           tilt_angle)
 # Utility functions
 from .utils import (azel_to_thetaphi, create_theta_phi_grid, create_uv_grid,
                     db_to_linear, deg2rad, frequency_to_k,
@@ -143,7 +158,11 @@ __all__ = [
     "create_rectangular_subarrays",
     "compute_subarray_weights",
     "array_factor_conformal",
-    # Beamforming
+    # Geometry - Overlapped subarrays
+    "create_overlapped_subarrays",
+    "overlapped_subarray_weights",
+    "compute_overlapped_pattern",
+    # Beamforming - Amplitude tapers
     "taylor_taper_1d",
     "taylor_taper_2d",
     "chebyshev_taper_1d",
@@ -161,13 +180,25 @@ __all__ = [
     "compute_taper_efficiency",
     "compute_taper_directivity_loss",
     "apply_taper_to_geometry",
+    # Beamforming - Null steering
     "null_steering_projection",
     "null_steering_lcmv",
     "compute_null_depth",
+    # Beamforming - Multi-beam
     "multi_beam_weights_superposition",
     "multi_beam_weights_orthogonal",
     "compute_beam_isolation",
     "monopulse_weights",
+    # Beamforming - Beam spoiling
+    "quadratic_phase_spoil",
+    "compute_spoil_factor",
+    "spoiled_beam_gain",
+    "spoiled_beamwidth",
+    # Beamforming - Adaptive (SMI/GSC)
+    "adaptive_weights_smi",
+    "adaptive_weights_gsc",
+    "compute_sinr_improvement",
+    "plot_adapted_pattern",
     # Impairments
     "mutual_coupling_matrix_theoretical",
     "mutual_coupling_matrix_measured",
@@ -183,6 +214,12 @@ __all__ = [
     "scan_blindness_model",
     "apply_scan_blindness",
     "compute_scan_loss",
+    # Impairments - Active impedance/VSWR
+    "active_reflection_coefficient",
+    "active_impedance",
+    "vswr_vs_scan",
+    "mismatch_loss",
+    "active_scan_impedance_matrix",
     # Visualization
     "plot_pattern_2d",
     "plot_pattern_polar",
@@ -222,4 +259,23 @@ __all__ = [
     "plot_pattern_vs_frequency",
     "plot_pattern_vs_frequency_plotly",
     "plot_subarray_delays",
+    # Polarization
+    "jones_vector",
+    "stokes_parameters",
+    "axial_ratio",
+    "tilt_angle",
+    "cross_pol_discrimination",
+    "polarization_loss_factor",
+    "co_pol_pattern",
+    "cross_pol_pattern",
+    "ludwig3_decomposition",
+    # Coordinates
+    "antenna_to_radar",
+    "radar_to_antenna",
+    "antenna_to_cone",
+    "cone_to_antenna",
+    "rotation_matrix_roll",
+    "rotation_matrix_pitch",
+    "rotation_matrix_yaw",
+    "rotate_pattern",
 ]