docs: add calculation examples - #19
Merged
Merged
Conversation
tdpham2
force-pushed
the
docs/calculation-examples-review
branch
from
September 5, 2026 21:31
c71faa1 to
5cd7a03
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
MatKit's calculation workflows lacked a consolidated set of runnable examples using public APIs. Add four Python programs and a Python/CLI guide covering Zeo++ analysis and screening, single-component gRASPA execution and pressure sweeps, mixture preparation, and MLIP evaluation, fixed-cell relaxation, and batches across MACE, Rootstock, and ALCHEMI.
The examples delegate engine execution, parsing, and persistence to MatKit. Add 20 example tests and include the new programs and tests in CI lint checks. No files under
src/change.Validation
PYTHONPATH=src python -m pytest -q --ignore=tests/test_mcp_api.py: 405 passed, 1 skipped, including 20 new example tests.src/, the new programs, and their tests; the new files are included in CI lint checks.git diff --checkpassed.The local MCP tests were excluded because the installed SDK is 1.16.0 while the project requires SDK 2. Tests use synthetic engines and calculator doubles; no real-engine or GPU execution was available. Mixture examples prepare inputs only, matching the current public API capability.