md-analysis-planner
Skill83 starsChanged 9 months agoApache-2.0View on GitHub
Plan molecular dynamics post-processing for materials simulations, including RDF, MSD and diffusion, VACF/VDOS, coordination numbers, bond-angle distributions, stress-strain curves, equilibration detection, PBC unwrapping, and trajectory format choices. Use before writing MD analysis scripts or trusting trajectory-derived results.
In this repository23 other files it gives its agents.
- convergence-studySkill
- differentiation-schemesSkill
- linear-solversSkill
- mesh-generationSkill
- nonlinear-solversSkill
- numerical-integrationSkill
- numerical-stabilitySkill
- time-steppingSkill
- fair-simulation-packagerSkill
- hpc-runtime-doctorSkill
- slurm-job-script-generatorSkill
- skill-evaluatorSkill
- ontology-explorerSkill
- ontology-mapperSkill
- ontology-validatorSkill
- simulation-failure-triageSkill
- parameter-optimizationSkill
- performance-profilingSkill
- post-processingSkill
- simulation-orchestratorSkill
- simulation-validatorSkill
- workflow-engine-mapperSkill
- benchmark-and-mms-plannerSkill
The file
We split this skill into the rules it gives an agent
8 rules. About 0 are common, 7 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈7
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 55
Use RDF and coordination for local structure.
- Distinctive: line 56
Use MSD for diffusion, but unwrap trajectories and verify diffusive regime.
- Distinctive: line 57
Use VACF/VDOS only when velocities or reliable finite-difference velocities exist.
- Distinctive: line 58
Use stress-strain only if stress/virial and deformation history are available.
- Distinctive: line 59
Always perform equilibration checks before fitting transport or thermodynamic properties.
- Distinctive: line 100
If velocities, stress, or timestep information is missing, downgrade dependent analyses and report warnings.
- Distinctive: line 111
Do not trust trajectory-derived results until each applicable item below is recorded against the planner's own output:
- Very specific: line 171
No use of eval, exec, os.system, or dynamic imports.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 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.
Files
MD Analysis Planner
Goal
Choose the right MD trajectory analyses and prerequisites before writing post-processing code.
Requirements
- Python 3.10+
- No external dependencies
- Works on Linux, macOS, and Windows
Inputs to Gather
| Input | Description | Example |
| System | Material or molecular system | oxide glass, liquid water |
| Goals | Analysis goals | rdf,diffusion,coordination |
| Trajectory format | Dump, DCD, XYZ, H5MD, etc. | LAMMPS dump |
| Velocities | Whether velocities are stored | true |
| Stress | Whether stress/virial is stored | true |
| Unwrap needed | Whether atoms cross PBC | true |
| Timestep | fs per saved frame | 10 |
Decision Guidance
- Use RDF and coordination for local structure.
- Use MSD for diffusion, but unwrap trajectories and verify diffusive regime.
- Use VACF/VDOS only when velocities or reliable finite-difference velocities exist.
- Use stress-strain only if stress/virial and deformation history are available.
- Always perform equilibration checks before fitting transport or thermodynamic properties.
Script Outputs
scripts/md_analysis_planner.py emits these fields (JSON under results):
| Field | Description |
analysis_plan | One entry per goal: goal, method, and status |
required_data | Sorted, de-duplicated data needed across all goals |
equilibration_checks | Standard pre-fit equilibration checklist |
pbc_handling | unwrap_needed, minimum_action, format_note |
warnings | Safety-critical caveats and blockers |
Status values
status is one of, from most to least severe: blocked > needs time axis >
needs review > ready. A more-severe status is never demoted by a less-severe
one. For example, a VACF/VDOS goal with no stored velocities reports blocked
even when the timestep is also missing (both warnings are still emitted).
Default (non-JSON) output
Without --json the script prints the plan lines, a Required data: list, a
one-line PBC: note, and a Warnings: section (also mirrored to stderr) so the
safety-critical caveats are visible even when stdout is piped.
Workflow
python3 skills/simulation-workflow/md-analysis-planner/scripts/md_analysis_planner.py \
--system "oxide glass" \
--goals rdf,coordination,bond-angle \
--trajectory-format dump \
--unwrap-needed \
--timestep-fs 10 \
--jsonError Handling
If velocities, stress, or timestep information is missing, downgrade dependent
analyses and report warnings. The script exits with code 2 and a message on
stderr for invalid input (empty system, no goals, non-positive or non-finite
timestep, or inputs exceeding the size caps below).
Limitations
This skill plans analysis and prerequisites; it does not parse large trajectories directly.
Verification checklist
Do not trust trajectory-derived results until each applicable item below is recorded against the planner's own output:
- Ran
scripts/md_analysis_planner.pyand confirmed noanalysis_planentry isblockedorneeds time axis; record anyneeds reviewgoal and how its custom analysis was resolved. - Confirmed every item in the planner's
required_datalist is actually present in the trajectory (e.g.velocitiesfor VACF/VDOS,stress or virial+strain historyfor stress-strain) before running the corresponding analysis. - For diffusion/MSD: recorded the log-log MSD-vs-time slope and confirmed it is ~1 (diffusive regime) over the fit window, excluding ballistic/sub-diffusive transients, before quoting D = lim MSD/(2dt).
- For diffusion/MSD: assessed whether a hydrodynamic finite-size correction is applicable. For isotropic bulk fluids in 3D periodic cubic cells, record L, T and shear viscosity eta if applying Yeh-Hummer (D_0 = D_PBC + k_BTxi/(6pieta*L), xi~=2.837). Report the measured D_PBC, the correction and its assumptions separately. Do not apply this formula automatically to solids, confined or anisotropic systems, non-cubic cells or ballistic trajectories.
- For any displacement-based analysis when
pbc_handling.unwrap_neededis true: confirmed positions were unwrapped usingcell+image flagsbefore computing displacements (not raw wrapped coordinates). - Worked through the planner's
equilibration_checks: discarded the startup transient, confirmed temperature/pressure plateaus, and compared first-half vs second-half property estimates before any transport/thermodynamic fit. - Reported an uncertainty from block averaging (or independent trajectories) for every quoted transport/thermodynamic property, not a single-window point value.
Common pitfalls & rationalizations
| Tempting shortcut | Why it's wrong / what to do |
| "MSD vs time looks straight, so it's diffusive — just fit a line." | A straight-looking MSD can still include ballistic/sub-diffusive transients. Confirm the log-log slope is ~1 over the fit window first, then fit D = lim MSD/(2dt). |
| "D from the simulation is the diffusion coefficient." | Assess size dependence and report D_PBC. The Yeh-Hummer 1/L hydrodynamic correction applies under bulk-fluid, 3D periodic cubic-cell assumptions; justify those assumptions and the viscosity before separately reporting a corrected D_0. |
| "Positions are in the dump, so MSD is fine." | Wrapped coordinates make atoms jump across the box and corrupt displacements. When unwrap_needed is true, unwrap using cell + image flags before any displacement analysis. |
| "No velocities stored, but I can get VACF/VDOS from positions." | The planner marks VACF/VDOS blocked without velocities for a reason. A finite-difference velocity estimate must be explicitly justified (frame spacing, aliasing); otherwise the result is unreliable. |
| "The run finished, so I can fit transport properties on the whole trajectory." | Run completion is not equilibration. Discard the startup transient and verify temperature/pressure plateaus (the equilibration_checks) before fitting. |
| "One window gave a clean number, no need for error bars." | A single window hides correlation-driven variance. Use block averaging or independent trajectories so every transport/thermodynamic value carries an uncertainty. |
Security
Input Validation
Inputs are scalar CLI values and booleans only. plan_md_analysis validates and
bounds every field before use; any violation raises ValueError, which main
catches to print a message on stderr and exit with code 2:
systemmust be non-empty (after stripping) and at most 256 characters.- At most 64 goals are allowed; each goal at most 256 characters.
trajectory_formatat most 256 characters.timestep_fs, if given, must be a positive, finite number (math.isfiniteand> 0).
Goals are not allowlisted: an unrecognized goal is not rejected but is reported
with status needs review and an "unknown goal" warning. The --has-velocities,
--has-stress, and --unwrap-needed flags are plain booleans and need no
validation.
File Access
The script reads and writes no files; all I/O is stdin/args -> stdout (plain text or JSON), with warnings additionally mirrored to stderr. It takes no path arguments and opens no trajectory or output files, so there is no filesystem sandboxing concern. There are no per-file size limits because no files are read; input size is instead capped by the field/goal limits above.
Tool Restrictions
Frontmatter allowed-tools is Read, Bash, Write, Grep, Glob:
Bashis used only to run the bundledscripts/md_analysis_planner.py.Read,Write,Grep, andGlobare used only to inspect, edit, and search this skill's own files (the script, references, and SKILL.md) when authoring analysis plans; they are not used to touch trajectory data.
Safety Measures
- No use of
eval,exec,os.system, or dynamic imports. - The script spawns no subprocesses and executes no external analysis programs;
it only parses arguments with
argparseand computes a plan in-process. - Output is structured JSON produced via
json.dumps(or deterministic plain text), never interpolated shell. - Denial-of-service caps (
MAX_GOALS = 64,MAX_SYSTEM_LEN = 256,MAX_FIELD_LEN = 256) bound the work so a planning helper never materializes pathological input.
References
For a final readiness explanation from trusted, input-verified tool JSON, use the deterministic explanation renderer. A blocked VACF plan means readiness is false; the explanation and boolean must agree. Null means unresolved, and a ready plan does not validate a computed material property.
- See
references/md_analysis_checks.mdfor analysis prerequisites and failure modes. - Yeh and Hummer (2004), https://doi.org/10.1021/jp0477147: bulk-fluid periodic finite-size correction, not a universal correction for all materials.
Version History
- v1.2.3 (2026-10-19): Limit finite-size diffusion corrections to their justified physical regime.
- 1.2.0: Add deterministic
script_checksto all three eval cases that pin the exact planner output (statuses, sortedrequired_data, PBC note, and the specific diffusive-regime / Yeh-Hummer / blocked-not-demoted warnings) so the evals discriminate the skill from a from-memory baseline. - 1.1.0: Fix status demotion (blocked never downgraded to needs time axis), surface warnings/required-data/PBC in non-JSON mode, add diffusive-regime and Yeh-Hummer finite-size guidance, and enforce documented input caps.
- 1.0.0: Initial MD analysis planning skill.
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
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.

