Skip to content

Make MBIS first-class in the docs (part 1) - #6

Merged
shehan807 merged 4 commits into
mainfrom
docs/mbis-first-class
Nov 16, 2026
Merged

shehan807 merged 4 commits into
mainfrom
docs/mbis-first-class

Conversation

@shehan807

Copy link
Copy Markdown
Owner

Makes MBIS a first-class method in the user-facing docs, alongside GDMA. The MBIS code and the API reference page already shipped; this fills in the narrative surfaces so a reader actually discovers it.

  • README: the intro and feature list now mention MBIS, with a short MBIS snippet next to the GDMA quick example.
  • New runnable example examples/mbis-charges.py showing both the raw MBIS charges and the MPFIT refit.
  • User guide: new "MBIS Settings" and "Generating MBIS Data and Charges" sections, plus a note on MoleculeMBISStore.
  • Intro and installation docs mention MBIS, and note that it needs no packages beyond psi4.

This is part 1 (docs and examples). The JOSS paper update and small code tidy-ups (dedupe the MultipoleRecord alias, promote the stores to the top level) will follow in part 2.

Docs only, no code changes. Lint is clean; RST section structure checked.

Copilot AI balanced review requested due to automatic review settings November 13, 2026 02:49

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@shehan807
shehan807 merged commit f12b6d4 into main Nov 16, 2026
3 checks passed
@shehan807
shehan807 deleted the docs/mbis-first-class branch November 16, 2026 01:22
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