Skip to content

docs: add calculation examples - #19

Merged
tdpham2 merged 1 commit into
mainfrom
docs/calculation-examples-review
Sep 5, 2026
Merged

docs: add calculation examples#19
tdpham2 merged 1 commit into
mainfrom
docs/calculation-examples-review

Conversation

@tdpham2

@tdpham2 tdpham2 commented Sep 5, 2026

Copy link
Copy Markdown
Owner

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.
  • Ruff lint and formatting checks passed for src/, the new programs, and their tests; the new files are included in CI lint checks.
  • Guide JSON specifications validate against the public request/profile models; Python snippets and local links were checked.
  • git diff --check passed.

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.

@tdpham2
tdpham2 force-pushed the docs/calculation-examples-review branch from c71faa1 to 5cd7a03 Compare September 5, 2026 21:31
@tdpham2 tdpham2 changed the title docs: add calculation examples and source review docs: add calculation examples Sep 5, 2026
@tdpham2
tdpham2 merged commit 4e560cd into main Sep 5, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant