bug(ext_pot): fix enum naming and add docs#321
Merged
HaoZeke merged 4 commits intoTheochemUI:mainfrom Mar 1, 2026
Merged
Conversation
eOn Documentation PreviewDownload: documentation.zip Unzip and open |
magic_enum maps config strings to enum names case-insensitively. The config uses "ext_pot" but the enum was named "EXT", causing eonclient to fall through to PotType::UNKNOWN. Rename the enum variant so the two match. Add an ExtPot unit test with a harmonic spring script (k=1, r0=1) that verifies the file-based protocol end-to-end.
Add a dedicated ext_pot documentation page covering the file-based protocol, configuration, and worked examples (DeePMD, generic ASE). This addresses discussion TheochemUI#318 where a conda-forge user tried the LAMMPS potential (not compiled in) instead of ext_pot. Add conda-forge availability admonitions to every potential and feature page so users can tell at a glance what ships in the conda-forge package vs. what requires a source build.
HaoZeke
force-pushed
the
docs/ext-pot-guide
branch
from
90cb2f2 to
58547ab
Compare
The HaoZeke/asv_spyglass fork branch enh-multiple-comparisons no longer exists now that compare-many landed upstream. Point to airspeed-velocity/asv_spyglass instead. Also add rm -rf benchmarks before cp -r restore to prevent nested copy when the directory already exists after git checkout, and use the v1 floating tag for asv-perch.
Benchmark ResultsTip 1 benchmark(s) improved
Improvements
7 unchanged benchmark(s)
Details
Raw asv-spyglass output |
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
1 participant
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.
Noted in #318 by @Mem314.
eonclientwas expecteingextfor the External potentials but the server (and for backwards compatibility) expectsext_pot. Also adds documentation to ensure the usage is clearer.