FAIR Simulation Packager
Goal
Build a minimal reproducibility manifest for materials simulation results so another person or agent can understand what was run, with which inputs, and how outputs should be interpreted.
Requirements
- Python 3.10+
- No external dependencies
- Works on Linux, macOS, and Windows
Inputs to Gather
| Input |
Description |
Example |
| Project name |
Human-readable bundle name |
al-cu-diffusion-study |
| Engine |
Simulation code |
LAMMPS, VASP, MOOSE |
| Input files |
Files needed to rerun |
in.lammps,data.lmp |
| Output files |
Files needed to verify results |
log.lammps,traj.dump |
| Structure ID |
Database or local identifier |
mp-149 |
| Units |
Field/unit mapping |
energy=eV,length=angstrom |
Decision Guidance
- Always include input files, output files, code version, and units.
- Include hashes for every file that exists locally.
- Include structure identifiers when using Materials Project, NOMAD, OPTIMADE, CIF, POSCAR, or internal database records.
- Record missing files as warnings instead of silently dropping them.
Script Outputs
scripts/fair_packager.py emits:
manifest
file_inventory
missing_files
fair_checks
recommended_next_steps
Workflow
python3 skills/data-management/fair-simulation-packager/scripts/fair_packager.py \
--project-name al-cu-diffusion \
--engine LAMMPS \
--inputs in.lammps,data.lmp \
--outputs log.lammps,traj.dump \
--units energy=eV,length=angstrom,time=ps \
--structure-id local:alcu-cell-001 \
--json
Use --out manifest.json only when the user wants a manifest file written.
Error Handling
Missing files are reported in missing_files; invalid unit fields or unsafe paths stop with exit code 2.
Limitations
This skill creates a metadata manifest. It does not upload to NOMAD, Materials Project, or an OPTIMADE provider.
Security
- File paths are read only for metadata and SHA-256 hashing.
- The script rejects control characters and oversized files above 500 MB.
- Optional manifest writing is restricted to the requested output path.
- The skill uses
Bash only to run the bundled script.
References
- See
references/fair_manifest.md for recommended manifest fields.
Version History
- 1.0.0: Initial FAIR simulation packaging skill.
1---2name: fair-simulation-packager3description: >4 Create FAIR-minded reproducibility bundles for materials simulations by5 collecting input/output file inventories, hashes, units, engine versions,6 structure identifiers, provenance, and NOMAD/OPTIMADE/Materials Project7 friendly metadata. Use before publishing, sharing, archiving, or handing8 simulation results to another agent.9allowed-tools: Read, Bash, Write, Grep, Glob10metadata:11 source: https://skillmd.com/skills/zuoguyoupan2023/fair-simulation-packager12 author: HeshamFS13 version: "1.0.0"14 security_tier: high15 security_reviewed: true16 tested_with:17 - claude-code18 - gemini-cli19 - vs-code-copilot20 eval_cases: 321 last_reviewed: "2026-05-18"22---2324# FAIR Simulation Packager2526## Goal2728Build a minimal reproducibility manifest for materials simulation results so another person or agent can understand what was run, with which inputs, and how outputs should be interpreted.2930## Requirements3132- Python 3.10+33- No external dependencies34- Works on Linux, macOS, and Windows3536## Inputs to Gather3738| Input | Description | Example |39|-------|-------------|---------|40| Project name | Human-readable bundle name | `al-cu-diffusion-study` |41| Engine | Simulation code | `LAMMPS`, `VASP`, `MOOSE` |42| Input files | Files needed to rerun | `in.lammps,data.lmp` |43| Output files | Files needed to verify results | `log.lammps,traj.dump` |44| Structure ID | Database or local identifier | `mp-149` |45| Units | Field/unit mapping | `energy=eV,length=angstrom` |4647## Decision Guidance4849- Always include input files, output files, code version, and units.50- Include hashes for every file that exists locally.51- Include structure identifiers when using Materials Project, NOMAD, OPTIMADE, CIF, POSCAR, or internal database records.52- Record missing files as warnings instead of silently dropping them.5354## Script Outputs5556`scripts/fair_packager.py` emits:5758- `manifest`59- `file_inventory`60- `missing_files`61- `fair_checks`62- `recommended_next_steps`6364## Workflow6566```bash67python3 skills/data-management/fair-simulation-packager/scripts/fair_packager.py \68 --project-name al-cu-diffusion \69 --engine LAMMPS \70 --inputs in.lammps,data.lmp \71 --outputs log.lammps,traj.dump \72 --units energy=eV,length=angstrom,time=ps \73 --structure-id local:alcu-cell-001 \74 --json75```7677Use `--out manifest.json` only when the user wants a manifest file written.7879## Error Handling8081Missing files are reported in `missing_files`; invalid unit fields or unsafe paths stop with exit code 2.8283## Limitations8485This skill creates a metadata manifest. It does not upload to NOMAD, Materials Project, or an OPTIMADE provider.8687## Security8889- File paths are read only for metadata and SHA-256 hashing.90- The script rejects control characters and oversized files above 500 MB.91- Optional manifest writing is restricted to the requested output path.92- The skill uses `Bash` only to run the bundled script.9394## References9596- See `references/fair_manifest.md` for recommended manifest fields.9798## Version History99100- 1.0.0: Initial FAIR simulation packaging skill.