Skip to main content

MaxwellLink: A unified framework for self-consistent light-matter simulations

Project description

MaxwellLink icon

Docs badge License: GPLv2 Python versions

MaxwellLink is a free and open-source framework for self-consistent light–matter simulations. It bridges electromagnetic solvers, such as Meep or the built-in single-mode cavity, with heterogeneous molecular drivers spanning QuTiP, Psi4, ASE, and LAMMPS. This code can be used for both demonstration and production calculation purposes. Particularly, with a socket-based architecture, large-scale self-consistent light-matter simulations can be performed efficiently accross multiple HPC nodes.

Key Features

  • Embracing state-of-the-art ecosystems in both computational electrodynamics and quantum chemistry, extending the boundary of light-matter simulations.
  • Unified Python interfaces for socket-connected and embedded molecular drivers in light-matter simulations.
  • Heterogeneous molecular theories including TLS, QuTiP model Hamiltonians, Psi4 RT-TDDFT/Ehrenfest, ASE classical dynamics, and LAMMPS via fix mxl, all in one EM simulation.
  • Extensible code structure to add custom EM solvers or molecular drivers with minimal efforts.

Quick Start

Create a fresh conda environment and install from source:

CONDA_ENV="mxl"
conda create -n "$CONDA_ENV" python=3.13
conda activate "$CONDA_ENV"

git clone https://github.com/TaoELi/MaxwellLink.git
cd MaxwellLink
pip install .

Optional drivers (Meep, QuTiP, Psi4, ASE, LAMMPS) can be added by following the instructions in the documentation.

Documentation

Visit the documentation for installation details, tutorials, API reference, and guidelines on extending MaxwellLink.

Citation

If MaxwellLink helps your research, please cite this project together with the coupled solvers you employ (e.g., Meep, Psi4, QuTiP, ASE, LAMMPS).

  • X Ji †, AF Bocanegra Vargas †, G Meng, and TE Li. MaxwellLink: A Unified Framework for Self-Consistent Light-Matter Simulations. arXiv:2512.06173 (2025). [data]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

maxwelllink-0.2.0.tar.gz (126.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

maxwelllink-0.2.0-py3-none-any.whl (138.8 kB view details)

Uploaded Python 3

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page