mxl-core

星标10

分支5

更新时间2026年5月9日 17:17

This skill should be used when users need the canonical MaxwellLink workflow, including socket vs embedded coupling, units/time handling, and MPI/HPC invariants.

安装

用 Codex 或 Claude 帮你安装复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。

来源

TaoELi

TaoELi/MaxwellLink

打开 GitHub 仓库查看创作者相关仓库

下载

MaxwellLink core workflow

Enforce invariants

Create new runnable inputs only under projects/YYYY-MM-DD-NAME/.
Keep runs reproducible by storing parameters in a config.json (or similar) and avoiding hard-coded absolute paths.
Never pass both hub=... and driver=... to maxwelllink.Molecule; provide exactly one.

Choose coupling mode

Use embedded mode when the driver can run in the same Python process:
- Construct molecules with Molecule(driver="<id>", driver_kwargs={...}).
Use socket mode when drivers must run as separate processes or nodes:
- Construct a SocketHub(...), pass hub=hub into each Molecule(...), and launch one mxl_driver --model <id> ... per molecule.
If local socket runs fail with MPI/network permission errors, prefer embedded mode (Molecule(driver="...", ...)) on local machines and reserve socket mode for SLURM/HPC.
For local socket mode, you can disable MPI auto-init with MPI4PY_RC_INITIALIZE=0 and ensure loopback NIC usage (use 127.0.0.1; set site-specific NIC selection env vars if MPI/OFI tries a non-loopback interface).

Handle units/time

For Meep: set time_units_fs on MeepSimulation(...) and keep it consistent when interpreting driver times.
For SingleMode/LaserDriven: work directly in atomic units and set dt_au explicitly.

Handle MPI and multi-process execution

Launch socket drivers only once (rank 0) under MPI; rely on MaxwellLink broadcasts for other ranks.
Set generous timeout for HPC and tune latency to match driver cost.
If attaching many molecules, consider store_additional_data=False for most molecules to limit memory usage; keep it True only for the molecules you intend to export/plot.

Validate before running

Use skills/mxl-project-scaffold/scripts/mxl_validate_project.py to sanity-check config.json and required files.
When debugging behavior, compare to patterns in tests/ and docs/source/usage.rst.

References

Solver choice: skills/mxl-core/references/solver_quickref.md
Driver choice: skills/mxl-core/references/driver_quickref.md

同仓库更多 Skills

同仓库

mxl-multimode

TaoELi/MaxwellLink

This skill should be used when users need the MaxwellLink multimode Fabry-Pérot cavity solver to study a spatial grid of molecules coupled to many photonic modes (mesoscale VSC), in either socket or embedded mode.

2026-05-1110

mxl-singlemode

TaoELi/MaxwellLink

This skill should be used when users need the MaxwellLink single-mode cavity solver for fast prototyping and regression, in either socket or embedded mode.

2026-05-0910

mxl-index

TaoELi/MaxwellLink

This skill should be used when users ask how to set up, choose, or run a MaxwellLink simulation and the correct solver/driver/HPC/post-processing workflow must be selected.

2026-05-0510

mxl-driver-dftbplus

TaoELi/MaxwellLink

This skill should be used when users want to couple MaxwellLink to the MaxwellLink-aware DFTB+ fork via the `MaxwellLinkSocket` block, including real-time Ehrenfest dynamics, VelocityVerlet Born-Oppenheimer MD, dipole-derivative choices, build/install, and TCP/UNIX socket connection patterns.

2026-04-2910

mxl-cli

TaoELi/MaxwellLink

This skill should be used when users need to initialize, clean, or configure MaxwellLink workspaces using the mxl command family.

2026-03-1910

mxl-hpc-slurm

TaoELi/MaxwellLink

This skill should be used when users need to run MaxwellLink in SLURM/HPC environments, including dependent job patterns and robust socket host/port handoff.

2026-03-1910

MaxwellLink core workflow

Enforce invariants

Create new runnable inputs only under projects/YYYY-MM-DD-NAME/.

Keep runs reproducible by storing parameters in a config.json (or similar) and avoiding hard-coded absolute paths.

Never pass both hub=... and driver=... to maxwelllink.Molecule; provide exactly one.

Choose coupling mode

Use embedded mode when the driver can run in the same Python process:

Construct molecules with Molecule(driver="<id>", driver_kwargs={...}).

Use socket mode when drivers must run as separate processes or nodes:

Construct a SocketHub(...), pass hub=hub into each Molecule(...), and launch one mxl_driver --model <id> ... per molecule.

If local socket runs fail with MPI/network permission errors, prefer embedded mode (Molecule(driver="...", ...)) on local machines and reserve socket mode for SLURM/HPC.

For local socket mode, you can disable MPI auto-init with MPI4PY_RC_INITIALIZE=0 and ensure loopback NIC usage (use 127.0.0.1; set site-specific NIC selection env vars if MPI/OFI tries a non-loopback interface).

Handle units/time

For Meep: set time_units_fs on MeepSimulation(...) and keep it consistent when interpreting driver times.

For SingleMode/LaserDriven: work directly in atomic units and set dt_au explicitly.

Handle MPI and multi-process execution

Launch socket drivers only once (rank 0) under MPI; rely on MaxwellLink broadcasts for other ranks.

Set generous timeout for HPC and tune latency to match driver cost.

If attaching many molecules, consider store_additional_data=False for most molecules to limit memory usage; keep it True only for the molecules you intend to export/plot.

Validate before running

Use skills/mxl-project-scaffold/scripts/mxl_validate_project.py to sanity-check config.json and required files.

When debugging behavior, compare to patterns in tests/ and docs/source/usage.rst.

References

Solver choice: skills/mxl-core/references/solver_quickref.md

Driver choice: skills/mxl-core/references/driver_quickref.md

name	mxl-core
description	This skill should be used when users need the canonical MaxwellLink workflow, including socket vs embedded coupling, units/time handling, and MPI/HPC invariants.