pymaga 0.0.0__tar.gz

pymaga-0.0.0/LICENSE.md

@@ -0,0 +1,24 @@
+Copyright 2026, Thomas Spielauer
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain this list of conditions and the
+  following disclaimer.
+* Redistributions in binary form must reproduce this list of conditions and the
+  following disclaimer in the documentation and/or other materials provided with
+  the distribution.
+* Neither the name of the copyright holder nor the names of its contributors may
+  be used to endorse or promote products derived from this software without
+	specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pymaga-0.0.0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: pymaga
+Version: 0.0.0
+Summary: Magnetic Analysis with GPU Acceleration - A Python library for GPU-accelerated magnetic field calculations using the Biot-Savart law
+Author-email: Thomas Spielauer <pypipackages01@tspi.at>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/tspspi/maga
+Project-URL: Bug Reports, https://github.com/tspspi/maga/issues
+Keywords: magnetic-field,biot-savart,gpu-acceleration,opencl,physics,electromagnetic,simulation,coils,scientific-computing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Education
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: pyopencl>=2018.2
+Provides-Extra: visualization
+Requires-Dist: matplotlib>=3.8.0; extra == "visualization"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.1.1; extra == "dev"
+Requires-Dist: pytest-cov>=2.0; extra == "dev"
+Provides-Extra: all
+Requires-Dist: pymaga[dev,visualization]; extra == "all"
+Dynamic: license-file
+
+# Magnetic Analysis with GPU Acceleration (MAGA)
+
+MAGA (Magnetic Analysis with GPU Acceleration) is a Python library for GPU-accelerated
+magnetic field calculations using the Biot-Savart law. It supports arbitrary coil
+geometries via Python or OpenCL geometry generators. GPU acceleration is realized
+with OpenCL.
+
+> __magus, maga, magum__ <br>
+> _adjective_ <br>
+> magic, magical
+
+
+![](doc/maga01.png)
+
+## License
+
+See [LICENSE.md](./LICENSE.md)
+
+## Installation
+
+```
+pip install pymaga
+```
+
+## Usage
+
+Detailed usage examples can be seen in the ```examples``` directory.
+
+## Validation
+
+![Simulation of a Helmholz coil pair](verification/res/case_hh_1.png)
+
+Validation scenarios can be found in the ```verification``` directory.

pymaga-0.0.0/README.md

@@ -0,0 +1,33 @@
+# Magnetic Analysis with GPU Acceleration (MAGA)
+
+MAGA (Magnetic Analysis with GPU Acceleration) is a Python library for GPU-accelerated
+magnetic field calculations using the Biot-Savart law. It supports arbitrary coil
+geometries via Python or OpenCL geometry generators. GPU acceleration is realized
+with OpenCL.
+
+> __magus, maga, magum__ <br>
+> _adjective_ <br>
+> magic, magical
+
+
+![](doc/maga01.png)
+
+## License
+
+See [LICENSE.md](./LICENSE.md)
+
+## Installation
+
+```
+pip install pymaga
+```
+
+## Usage
+
+Detailed usage examples can be seen in the ```examples``` directory.
+
+## Validation
+
+![Simulation of a Helmholz coil pair](verification/res/case_hh_1.png)
+
+Validation scenarios can be found in the ```verification``` directory.

pymaga-0.0.0/pyproject.toml

@@ -0,0 +1,123 @@
+[build-system]
+requires = [
+	"setuptools>=63.1.0",
+	"wheel>=0.45.1",
+	"setuptools-git-versioning"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pymaga"
+dynamic = [ "version" ]
+description = "Magnetic Analysis with GPU Acceleration - A Python library for GPU-accelerated magnetic field calculations using the Biot-Savart law"
+authors = [
+        { name = "Thomas Spielauer", email = "pypipackages01@tspi.at" }
+]
+readme = "README.md"
+license = "BSD-3-Clause"
+license-files = [ "LICENSE.md" ]
+requires-python = ">=3.10"
+keywords = [
+    "magnetic-field",
+    "biot-savart",
+    "gpu-acceleration",
+    "opencl",
+    "physics",
+    "electromagnetic",
+    "simulation",
+    "coils",
+    "scientific-computing"
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Education",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Physics",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "numpy>=1.26.4",
+    "pyopencl>=2018.2",
+]
+
+[project.optional-dependencies]
+visualization = [
+    "matplotlib>=3.8.0",
+]
+dev = [
+    "pytest>=8.1.1",
+    "pytest-cov>=2.0"
+]
+all = [
+    "pymaga[visualization,dev]"
+]
+
+[project.urls]
+"Homepage" = "https://github.com/tspspi/maga"
+"Bug Reports" = "https://github.com/tspspi/maga/issues"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["maga*"]
+
+[tool.setuptools.package-data]
+maga = ["*.cl", "kernels/*.cl"]
+
+[tool.pytest.ini_options]
+minversion = "8.1.1"
+addopts = "-ra -q --strict-markers --strict-config"
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+markers = [
+    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+    "gpu: marks tests that require GPU/OpenCL support",
+    "integration: marks tests as integration tests",
+]
+
+[tool.pytest.coverage.run]
+source = ["src/maga"]
+omit = [
+    "*/tests/*",
+    "*/examples/*",
+    "*/__pycache__/*",
+]
+
+[tool.pytest.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if self.debug:",
+    "if settings.DEBUG",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if __name__ == .__main__.:",
+    "class .*\\bProtocol\\):",
+    "@(abc\\.)?abstractmethod",
+]
+
+[tool.coverage.run]
+source = ["src"]
+omit = [
+    "*/tests/*",
+    "*/examples/*",
+]
+
+[tool.coverage.report]
+precision = 2
+skip_covered = false
+skip_empty = false
+sort = "cover"

pymaga-0.0.0/setup.cfg

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

pymaga-0.0.0/src/maga/__init__.py

@@ -0,0 +1,175 @@
+"""
+MAGA: Magnetic Analysis with GPU Acceleration
+
+A Python library for GPU-accelerated magnetic field calculations using the Biot-Savart law.
+Provides high-performance computation of magnetic fields from arbitrary current geometries
+with support for various coil configurations and time-dependent simulations.
+
+Key Features:
+- GPU-accelerated Biot-Savart calculations using OpenCL
+- Multiple geometry types: circular coils, rectangular coils, coil pairs, electron beams
+- Flexible grid configurations for field mapping
+- Time-dependent simulations for dynamic systems
+- Automatic device selection with CPU fallback
+- Memory-efficient batching for large calculations
+
+Basic Usage:
+    >>> from maga import CircularCoil, RectangularGrid, MagneticFieldCalculator
+    >>> 
+    >>> # Create a circular coil
+    >>> coil = CircularCoil(center=(0,0,0), radius=1.0, current=10.0)
+    >>> 
+    >>> # Define calculation grid
+    >>> grid = RectangularGrid(x_range=(-2,2), y_range=(-2,2), z_range=(-1,1),
+    ...                       nx=21, ny=21, nz=11)
+    >>> 
+    >>> # Calculate magnetic field
+    >>> calculator = MagneticFieldCalculator()
+    >>> A, B, I = coil.get_geometry()
+    >>> result = calculator.calculate_magnetic_field(A, B, I, grid)
+    >>> 
+    >>> print(f"Max field: {result.max_field:.2e} T")
+
+Dependencies:
+- numpy: Numerical computing
+- pyopencl: OpenCL Python bindings for GPU acceleration
+- Optional: matplotlib for visualization
+
+Author: MAGA Development Team
+License: Open Source
+Version: 1.0.0
+"""
+
+__version__ = "1.0.0"
+__author__ = "MAGA Development Team"
+__license__ = "Open Source"
+
+# Import core computational components
+from .core import (
+    KernelRegistry,
+    DeviceManager,
+    DeviceInfo,
+    GridConfiguration,
+    RectangularGrid,
+    CylindricalGrid,
+    PlaneGrid,
+    CustomGrid,
+    MagneticFieldCalculator,
+    CalculationResult
+)
+
+# Import geometry components
+from .geometry import (
+    BaseGeometry,
+    GeometryParameters,
+    CircularCoil,
+    RectangularCoil,
+    OscillatingBeam,
+    OscillatingBeam2D,
+    ChoppedBeam,
+    HelmholtzCoils,
+    AntiHelmholtzCoils
+)
+
+# Main public API - commonly used classes
+__all__ = [
+    # Core calculation components
+    'MagneticFieldCalculator',
+    'CalculationResult',
+    
+    # Device and kernel management
+    'DeviceManager',
+    'DeviceInfo',
+    'KernelRegistry',
+    
+    # Grid configurations
+    'GridConfiguration',
+    'RectangularGrid',
+    'CylindricalGrid',
+    'PlaneGrid',
+    'CustomGrid',
+    
+    # Geometry base classes
+    'BaseGeometry',
+    'GeometryParameters',
+    
+    # Basic geometry types
+    'CircularCoil',
+    'RectangularCoil',
+    'OscillatingBeam',
+    'OscillatingBeam2D',
+    'ChoppedBeam',
+    
+    # Coil pair configurations
+    'HelmholtzCoils',
+    'AntiHelmholtzCoils',
+    
+    # Version information
+    '__version__',
+    '__author__',
+    '__license__'
+]
+
+# Convenience functions for common use cases
+def quick_coil_calculation(radius=1.0, current=1.0, grid_size=21, grid_range=2.0):
+    """
+    Quick magnetic field calculation for a circular coil.
+    
+    Args:
+        radius: Coil radius in meters
+        current: Current in Amperes
+        grid_size: Number of grid points per dimension
+        grid_range: Grid extends from -grid_range to +grid_range
+        
+    Returns:
+        CalculationResult object with magnetic field data
+    """
+    coil = CircularCoil(radius=radius, current=current)
+    grid = RectangularGrid(
+        x_range=(-grid_range, grid_range),
+        y_range=(-grid_range, grid_range),
+        z_range=(-grid_range/2, grid_range/2),
+        nx=grid_size, ny=grid_size, nz=grid_size//2
+    )
+    calculator = MagneticFieldCalculator()
+    A, B, I = coil.get_geometry()
+    return calculator.calculate_magnetic_field(A, B, I, grid)
+
+def list_opencl_devices():
+    """
+    List all available OpenCL devices.
+    
+    Returns:
+        List of device information strings
+    """
+    try:
+        manager = DeviceManager()
+        devices = manager.list_available_devices()
+        return [str(device) for device in devices]
+    except Exception as e:
+        return [f"Error listing devices: {e}"]
+
+# Package metadata
+def get_version_info():
+    """Get detailed version information."""
+    try:
+        import pyopencl as cl
+        opencl_version = cl.get_platforms()[0].version if cl.get_platforms() else "Not available"
+    except:
+        opencl_version = "Not available"
+        
+    try:
+        import numpy as np
+        numpy_version = np.__version__
+    except:
+        numpy_version = "Not available"
+        
+    return {
+        'maga_version': __version__,
+        'numpy_version': numpy_version,
+        'opencl_version': opencl_version,
+        'available_devices': len(list_opencl_devices())
+    }
+
+# Add convenience imports to global namespace
+__all__.extend(['quick_coil_calculation', 'list_opencl_devices', 'get_version_info'])

pymaga-0.0.0/src/maga/core/__init__.py

@@ -0,0 +1,30 @@
+"""
+Core computation modules for MAGA library.
+
+This package contains the fundamental computational components:
+- Kernel management and OpenCL kernel registry
+- Device management and OpenCL context handling  
+- Grid configuration for calculation domains
+- Magnetic field calculator (main computation engine)
+
+The core modules provide the low-level functionality needed for
+GPU-accelerated magnetic field calculations using the Biot-Savart law.
+"""
+
+from .kernels import KernelRegistry
+from .device_manager import DeviceManager, DeviceInfo
+from .grid import GridConfiguration, RectangularGrid, CylindricalGrid, PlaneGrid, CustomGrid
+from .field_calculator import MagneticFieldCalculator, CalculationResult
+
+__all__ = [
+    'KernelRegistry',
+    'DeviceManager',
+    'DeviceInfo',
+    'GridConfiguration',
+    'RectangularGrid',
+    'CylindricalGrid', 
+    'PlaneGrid',
+    'CustomGrid',
+    'MagneticFieldCalculator',
+    'CalculationResult'
+]