docs: Improve tutorial, fix benchmarks, add molecule constructors#66
Merged
ericchansen merged 1 commit intomasterfrom Mar 19, 2026
Merged
docs: Improve tutorial, fix benchmarks, add molecule constructors#66ericchansen merged 1 commit intomasterfrom
ericchansen merged 1 commit intomasterfrom
Conversation
Tutorial improvements from live review: - Add collapsible molecule constructor examples (Gaussian, QCElemental) - Connect Step 1 QM outputs to Step 2 molecule building - Combine and clarify bond_tolerance explanation - Add Hessian eigenmatrix training data warning (not yet ported) - Replace manual ReferenceData with loop-based extraction from molecule - Note future automation helper for ReferenceData Performance benchmarks: - Fix flawed data where L-BFGS-B/Powell showed ~0 initial scores - Regenerate from scripts/generate_benchmarks.py with identical starting params - Add L-BFGS-B convergence warning (final score 0.93 vs 0.000) - Update throughput numbers (OpenMM ~190 eval/s, Tinker ~1.3 eval/s) API reference: - Add Q2MMMolecule constructors table - Add Gaussian log example - Cross-link to tutorial for bond_tolerance details Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Summary
Improve tutorial docs from live review, fix flawed performance benchmarks, and enhance API reference.
Changes
Tutorial (
docs/tutorial.md)GaussLog, QCElemental, raw arrays)ReferenceDatavalues with loop-based extraction frommol.bonds/mol.anglesReferenceData.from_molecule()automation (see feat: Auto-populate ReferenceData from QM outputs and molecules #63)Performance benchmarks (
docs/performance.md)~0initial scores because they were run on already-optimized parameters instead of fresh starting pointsscripts/generate_benchmarks.pywith identical starting params (initial score 42.9 for all methods)API reference (
docs/api.md)Q2MMMoleculeconstructors table (from_xyz,from_structure,from_qcel, raw)bond_tolerancedetailsNew script
scripts/generate_benchmarks.py-- reproducible benchmark generation so performance data is never hand-written againRelated Issues
Testing
mkdocs build --strictpasses cleanruff check .passes