agentleFS
Hongyu-yuHongyu-yu/matsci-ai-skills/skills/openmx/SKILL.md

openmx

Skill19 starsChanged 10 months agoMITView on GitHub

OpenMX (openmx) workflows with emphasis on OpenMX v3.9: write and validate input .dat files (System.Name, Atoms.SpeciesAndCoordinates, scf.Kgrid, Band.kpath), run SCF/geometry optimization/band/DOS/NEB/ESM/SOC(+U)/unfolding/Wannier90/NEGF examples, and interpret outputs (.out/.scfout/restart). Trigger this skill whenever the user mentions OpenMX/openmx.

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 1 is distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use this skill when you need to run OpenMX calculations or prepare/inspect OpenMX inputs/outputs.

    line 8
  2. Very specific:

    If you run it from outside this repo, pass --root /path/to/openmx_example or set OPENMX_EXAMPLE_DIR.

    line 26
  3. Very specific:

    Create an input file work/<name>.dat (see template below).

    line 30
  4. Distinctive:

    Run OpenMX (serial or MPI):

    line 31
  5. Very specific:

    Check results in work/<System.Name>.out.

    line 34
  6. Very specific:

    If you need binary matrices for post-processing, set HS.fileout=ON to write work/<System.Name>.scfout.

    line 36

≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

OpenMX (v3.9-focused)

Use this skill when you need to run OpenMX calculations or prepare/inspect OpenMX inputs/outputs. The examples and notes here are aligned with the OpenMX v3.9 manual (openmx3.9.pdf) and this repo’s openmx_example/ library.

Example Library (This Repo)

This repository includes many ready-to-run OpenMX inputs under openmx_example/. Prefer starting from the closest example, then editing:

  • System.Name (unique per run)
  • DATA.PATH (points to DFT_DATA19 / basis+pseudopotential directory on your system)
  • Atoms.* and <Definition.of.Atomic.Species ...> (structure + basis/pseudo choices)

Example index: references/examples.md (NEB/ESM/work-function/NEGF/unfolding/SOC+U/etc.).

To search examples by feature:

python scripts/find_examples.py --pattern "MD\\.Type\\s+NEB"

If you run it from outside this repo, pass --root /path/to/openmx_example or set OPENMX_EXAMPLE_DIR.

Quick Start (Run a Calculation)

  1. Create an input file work/<name>.dat (see template below).
  2. Run OpenMX (serial or MPI):
    • Serial: openmx work/<name>.dat > work/<name>.std
    • MPI: mpirun -np <N> openmx work/<name>.dat > work/<name>.std
  3. Check results in work/<System.Name>.out.

If you need binary matrices for post-processing, set HS.fileout=ON to write work/<System.Name>.scfout.

Input File Template (Minimal)

OpenMX input is keyword-based; order is flexible. A minimal, common structure:

System.CurrrentDirectory   ./      # note the spelling in the manual
System.Name                mycalc

Species.Number  2
<Definition.of.Atomic.Species
H  H5.0-s1   H_PBE19
C  C5.0-s1p1 C_PBE19
Definition.of.Atomic.Species>

Atoms.Number  5
Atoms.SpeciesAndCoordinates.Unit  Ang
<Atoms.SpeciesAndCoordinates
1 C   0.000  0.000  0.000  2.0  0.5 0.5 0.5
2 H  -0.890 -0.629  0.000  0.5  0.5 0.5 0.5
Atoms.SpeciesAndCoordinates>

Atoms.UnitVectors.Unit  Ang
<Atoms.UnitVectors
10.0 0.0  0.0
0.0  10.0 0.0
0.0  0.0  10.0
Atoms.UnitVectors>

scf.XcType            GGA-PBE
scf.SpinPolarization  off        # off|on|nc
scf.Kgrid             1 1 1
scf.maxIter           100
scf.criterion         1.0e-10

HS.fileout            ON         # writes System.Name.scfout

Outputs to Expect

Common outputs (controlled by level.of.fileout in the input):

  • work/<System.Name>.out: main log (SCF history, energies, charges, geometry optimization history).
  • work/<System.Name> rst/: restart directory.
  • work/<System.Name>.scfout: binary Hamiltonian/overlap/density matrices when HS.fileout=ON.

Reference

  • Keyword cheat sheet: references/keywords.md
  • Example catalog (this repo): references/examples.md

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.