structure-figures
Generate or update schematic structure figures (SVGs) used in CLEED docs and example inputs.
When & Why to Use This Skill
This Claude skill automates the generation and maintenance of schematic structure figures in SVG format, specifically tailored for technical and scientific documentation. By utilizing specialized scripts, it ensures that visual representations of atomic structures—such as unit cells and surface slabs—remain accurate, consistent, and easily updatable within a documentation pipeline.
Use Cases
- Scientific Documentation: Automatically generate precise SVG diagrams for surface science projects, such as Ni111 unit cells or complex overlayer structures, directly for technical manuals.
- Automated Asset Updates: Refresh visual assets across documentation sets (e.g., CLEED docs) whenever the underlying example inputs or parameters change, ensuring visual-data synchronization.
- Technical Illustration Workflow: Streamline the creation of high-quality vector graphics that serve as the 'source of truth' for technical figures, allowing for easy conversion to other formats like PNG for publication.
| name | structure-figures |
|---|---|
| description | Generate or update schematic structure figures (SVGs) used in CLEED docs and example inputs. |
| short-description | Generate structure SVGs |
Structure Figures
Use this skill when adding or updating schematic structure figures for the CLEED examples and docs (e.g., Ni111 unit cell, Ni(111) slab, 2x2 O overlayer).
Quick start
Generate or refresh the SVGs in doc/_static/figures:
python3 skills/structure-figures/scripts/generate_structure_figures.py \
--out-dir doc/_static/figures
Notes
- The script is the source of truth for these assets:
doc/_static/figures/ni111_unit_cell.svgdoc/_static/figures/ni111_surface_slab.svgdoc/_static/figures/ni111_2x2o_overlayer.svg
- The figures are referenced from
doc/file_formats/bul.rstanddoc/file_formats/inp.rst; update captions or cross-references there if the examples change. - If PNGs are required for a downstream target, convert from SVG using a local
tool (e.g.,
rsvg-convertorinkscape) and commit only the resulting static asset files.