Skip to content

feat: split --vacancy into --vacancy-index and --vacancy-count#27

Merged
ToAmano merged 1 commit into
mainfrom
feat/vacancy-refactor
Jul 1, 2026
Merged

feat: split --vacancy into --vacancy-index and --vacancy-count#27
ToAmano merged 1 commit into
mainfrom
feat/vacancy-refactor

Conversation

@ToAmano

@ToAmano ToAmano commented Jul 1, 2026

Copy link
Copy Markdown
Owner

Refactors vacancy creation options in the CLI and core to address Issue #26.

Closes #26

  1. Splits the old heuristic-based --vacancy option into two unambiguous options:
    • --vacancy-index: For removing atoms at specific absolute indices (e.g. Si:0, C:33).
    • --vacancy-count: For randomly removing a specified number of atoms of an element.
  2. Maintains backward compatibility by aliasing --vacancy to --vacancy-index.
  3. Replaces the 3C-SiC vacancy example in examples/4_espresso_supercell to demonstrate a double vacancy creation (removing Si:0 and C:33) via the command line.
  4. Adds comprehensive unit and integration tests for both index-based and count-based vacancy generation.
  5. Updates README.md documentation and examples.

@cr-gpt

cr-gpt Bot commented Jul 1, 2026

Copy link
Copy Markdown

Seems you are using me but didn't get OPENAI_API_KEY seted in Variables/Secrets for this repo. you could follow readme for more information

@codecov

codecov Bot commented Jul 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@ToAmano ToAmano merged commit 5c63696 into main Jul 1, 2026
8 checks passed
@ToAmano ToAmano deleted the feat/vacancy-refactor branch July 1, 2026 06:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feat: Split --vacancy into explicit index-based and count-based options

1 participant