Repository navigation
Quick-win docs & config fixes - #4
Merged
Merged
Conversation
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.
|
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
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.
Small, high-confidence fixes plus a CI/env modernization, each as its own commit.
Docs & config quick-wins
radiusexample inuser_guide.rst— it's an interleaved[element, value, ...]list, not a flat[0.65, 0.65].getting_started.rst—pip installand a duplicatedconda activatehad escaped into a.. note::; also addopenff-interchange.Psi4GDMAGenerator._generate_input(compute_esp/compute_field→ the realcompute_mp)._legacy*.pymodules.LibraryChargeGeneratorblock in thegdma-charges.pyexample.]on thepaper.mdsoftware-design figure.CI / environment (unbreaks a now-red CI)
conda, whichsetup-micromambano longer puts on PATH (runner image drift) → usemicromamba.libint=2.9pin: it now forces an old psi4 build incompatible with currenteinsums, breakingimport psi4on both Linux and macOS. Removing it installs psi4 1.11 with a matching libint/einsums.libint=2.9pin + "resolved in psi4 1.10 build 3" note from README / installation.rst / getting_started.rst.Verified locally:
pre-commit run --all-filesclean; full suite 287 passed, 6 skipped (psi4 1.11).