Back to list
Liam-Deacon

structure-figures

by Liam-Deacon

Computational package for Low Energy Electron Diffraction using ML optimisation algorithms

4🍴 3📅 Jan 12, 2026

SKILL.md


name: structure-figures description: Generate or update schematic structure figures (SVGs) used in CLEED docs and example inputs. metadata: 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.svg
    • doc/_static/figures/ni111_surface_slab.svg
    • doc/_static/figures/ni111_2x2o_overlayer.svg
  • The figures are referenced from doc/file_formats/bul.rst and doc/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-convert or inkscape) and commit only the resulting static asset files.

Score

Total Score

65/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

+10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新

+5
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

+5

Reviews

💬

Reviews coming soon