mxl-cli

Estrelas10

Forks5

Atualizado19 de março de 2026 às 02:49

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

Instalação

Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.

Fonte

TaoELi

TaoELi/MaxwellLink

Abrir repositório GitHub Ver repositórios do creator

Download

Ocupações relacionadasSOC

Baseado na classificação ocupacional SOC

Desenvolvedores de softwareInformática e Matemática·SOC 15-1252

SKILL.md

readonly

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

MaxwellLink CLI workflow

When to use

Use this skill for questions or tasks about mxl commands:
- mxl init / mxl-init
- mxl clean / mxl-clean
- mxl hpc set <file>
Use this skill before running simulations when the workspace is not prepared yet.

Command behaviors

mxl init:
- Copies AGENTS.md into the current directory.
- Creates symlinks for src/, tests/, skills/, docs/, media/, tutorials/, and README.md.
- Creates CLAUDE.md and GEMINI.md symlinks pointing to local AGENTS.md.
- If sbatch is available, ensures ~/.maxwelllink/HPC_PROFILE.json exists (seeded from package default if needed).
- If sbatch is available, creates local HPC_PROFILE.json symlink to ~/.maxwelllink/HPC_PROFILE.json.
mxl clean:
- Removes local artifacts created by mxl init from the current directory.
- Leaves ~/.maxwelllink/HPC_PROFILE.json in place.
mxl hpc set <file>:
- Validates and installs a user profile JSON to ~/.maxwelllink/HPC_PROFILE.json.
- Expected keys: slurm_default_partition, slurm_defaults, slurm_resource_policy.

Conflict handling

If a target path already exists and differs from the managed target/content:
- mxl init and mxl clean fail with a conflict error.
- Re-run with --force to overwrite/remove conflicting paths.
Re-running mxl init or mxl clean without conflicts is idempotent.

References

CLI implementation: src/maxwelllink/cli/mxl.py
Init implementation: src/maxwelllink/cli/mxl_init.py
Clean implementation: src/maxwelllink/cli/mxl_clean.py
HPC profile command: src/maxwelllink/cli/mxl_hpc.py

Mais deste repositório

mesmo repositório

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-core

TaoELi/MaxwellLink

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

2026-05-0910

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-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

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

MaxwellLink CLI workflow

When to use

Use this skill for questions or tasks about mxl commands:
- mxl init / mxl-init
- mxl clean / mxl-clean
- mxl hpc set <file>
Use this skill before running simulations when the workspace is not prepared yet.

Command behaviors

mxl init:
- Copies AGENTS.md into the current directory.
- Creates symlinks for src/, tests/, skills/, docs/, media/, tutorials/, and README.md.
- Creates CLAUDE.md and GEMINI.md symlinks pointing to local AGENTS.md.
- If sbatch is available, ensures ~/.maxwelllink/HPC_PROFILE.json exists (seeded from package default if needed).
- If sbatch is available, creates local HPC_PROFILE.json symlink to ~/.maxwelllink/HPC_PROFILE.json.
mxl clean:
- Removes local artifacts created by mxl init from the current directory.
- Leaves ~/.maxwelllink/HPC_PROFILE.json in place.
mxl hpc set <file>:
- Validates and installs a user profile JSON to ~/.maxwelllink/HPC_PROFILE.json.
- Expected keys: slurm_default_partition, slurm_defaults, slurm_resource_policy.

Conflict handling

If a target path already exists and differs from the managed target/content:
- mxl init and mxl clean fail with a conflict error.
- Re-run with --force to overwrite/remove conflicting paths.
Re-running mxl init or mxl clean without conflicts is idempotent.

References

CLI implementation: src/maxwelllink/cli/mxl.py
Init implementation: src/maxwelllink/cli/mxl_init.py
Clean implementation: src/maxwelllink/cli/mxl_clean.py
HPC profile command: src/maxwelllink/cli/mxl_hpc.py