Skip to content

Add PACMOF2 module for charge prediction#7

Merged
tdpham2 merged 3 commits into
mainfrom
dev/add-pacmof2-module
May 26, 2026
Merged

Add PACMOF2 module for charge prediction#7
tdpham2 merged 3 commits into
mainfrom
dev/add-pacmof2-module

Conversation

@tdpham2

@tdpham2 tdpham2 commented May 26, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds a pacmof2 module wrapping the PACMOF2 library for predicting partial atomic charges in MOFs
  • Supports single CIF or batch directory processing via run_charge_prediction()
  • Adds CLI command: matkit pacmof2 predict --cif-dir <dir> --outdir <out>
  • Registers pacmof2 as an optional dependency (pip install matkit[pacmof2])

Test plan

  • pip install -e ".[pacmof2]" and verify import: from matkit.pacmof2 import run_charge_prediction
  • Run matkit pacmof2 predict --cif-dir <cifs> --outdir <out> on a folder of CIFs
  • Verify output CIFs contain _atom_site_charge annotations
  • Verify matkit pacmof2 predict --help renders correctly
  • Without pacmof2 installed, verify graceful ImportError message

tdpham2 added 3 commits May 26, 2026 10:40
Wraps the pacmof2 library to allow users to predict partial atomic
charges on single CIF files or directories of CIFs. Adds CLI command
(matkit pacmof2 predict), optional dependency, and typed result contract.
…ubstitution

The template had a hardcoded component block with literal "ADSORBATE" as the
MoleculeName, which was never replaced by setup_simulation(). Replace it with
the __COMPONENTS__ placeholder that generate_component_blocks() already handles.
@tdpham2 tdpham2 merged commit 2af1389 into main May 26, 2026
5 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