Skip to content

Quick-win docs & config fixes - #4

Merged
shehan807 merged 9 commits into
mainfrom
chore/quick-wins
Nov 11, 2026
Merged

shehan807 merged 9 commits into
mainfrom
chore/quick-wins

Conversation

@shehan807

@shehan807 shehan807 commented Nov 11, 2026 •

Copy link
Copy Markdown
Owner

Small, high-confidence fixes plus a CI/env modernization, each as its own commit.

Docs & config quick-wins

  • Fix wrong radius example in user_guide.rst — it's an interleaved [element, value, ...] list, not a flat [0.65, 0.65].
  • Fix broken install block in getting_started.rst — pip install and a duplicated conda activate had escaped into a .. note::; also add openff-interchange.
  • Fix phantom docstring params in Psi4GDMAGenerator._generate_input (compute_esp/compute_field → the real compute_mp).
  • Drop dead ruff per-file-ignores for the removed _legacy*.py modules.
  • Drop a stale TODO and dead LibraryChargeGenerator block in the gdma-charges.py example.
  • Remove a stray trailing ] on the paper.md software-design figure.

CI / environment (unbreaks a now-red CI)

  • CI "Conda Environment Information" step called conda, which setup-micromamba no longer puts on PATH (runner image drift) → use micromamba.
  • Drop the obsolete libint=2.9 pin: it now forces an old psi4 build incompatible with current einsums, breaking import psi4 on both Linux and macOS. Removing it installs psi4 1.11 with a matching libint/einsums.
  • Remove the obsolete libint=2.9 pin + "resolved in psi4 1.10 build 3" note from README / installation.rst / getting_started.rst.

Verified locally: pre-commit run --all-files clean; full suite 287 passed, 6 skipped (psi4 1.11).

GDMASettings.radius takes an interleaved [element, value, ...] list
per the field description, not a flat list of floats. The example in
user_guide.rst showed radius=[0.65, 0.65], which a user copy-pasting
into their own code would pass through pydantic (the field is typed
bare list, so no validation catches it), then silently misfit at the
Psi4 GDMA layer with no error surfaced. Replace with a properly
formatted example.
The pip install pympfit line and a duplicated conda activate pympfit
were indented inside a .. note:: directive, so sphinx rendered them as
embedded literal blocks inside the note box rather than as standalone
install steps. The page therefore documented a half-broken install
flow on the very first page a new user lands on. Restructure into
three properly-scoped blocks (conda env, pip install, libint note) and
sync the package list with README.md and docs/installation.rst.
Copilot AI balanced review requested due to automatic review settings November 11, 2026 15:41

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Files with missing lines Coverage Δ
pympfit/gdma/psi4.py 97.72% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@shehan807
shehan807 merged commit d535fa6 into main Nov 11, 2026
3 checks passed
@shehan807
shehan807 deleted the chore/quick-wins branch November 11, 2026 16:11
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.

3 participants