soliton_solver documentation#
soliton_solver is a GPU-accelerated scientific computing framework for nonlinear
partial differential equations describing topological solitons in two-dimensional
field theories.
The solver is designed around a theory-agnostic numerical core implemented with Numba CUDA kernels. Physical models are introduced as modular components using a dependency injection (DI) architecture, allowing new theories to be added without modifying the numerical engine.
The framework supports a wide range of models spanning condensed matter physics, topological magnetism, and high-energy gauge field theories.
Real-time visualization is provided via CUDA–OpenGL interoperability, enabling interactive exploration of nonlinear field dynamics directly on the GPU.
The project follows modern software engineering practices including continuous integration via GitHub Actions and continuous deployment to PyPI.
Contents
- Installation
- Quickstart
- Supported Theories
- Overview
- Ginzburg-Landau superconductor
- Anisotropic superconductor
- Baby Skyrme model
- Rotating Bose-Einstein Condensates
- Chern-Simons-Landau-Ginzburg Theory of Vortex Anyons
- Chiral Magnet with Demagnetization
- Liquid Crystal with flexoelectric depolarization
- Ferromagnetic superconductor
- Spin-triplet superconducting magnet
- Initial configurations and multi-soliton construction
- Summary
- Using theories in simulations
- Adding a new theory
- Numerical Solver
- Validation
- GPU Acceleration via Numba CUDA
- Visualization with CUDA-OpenGL Interoperability
- Architecture
- Extending the Solver
- API Reference
- Quick start
- soliton_solver.theories
- soliton_solver.core.simulation
- soliton_solver.core.params
- soliton_solver.core.integrator
- soliton_solver.core.derivatives
- soliton_solver.core.utils
- soliton_solver.core.colormaps
- soliton_solver.visualization.gl_backend
- Theory interface
- Common patterns
- Extending the solver