Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update getting started guide, example script #68

Merged
merged 7 commits into from
Oct 17, 2024

Conversation

mattwthompson
Copy link
Member

@mattwthompson mattwthompson commented Oct 11, 2024

  • Update "getting started" section
    • Add bit about grabbing data from QCSubmit
  • Add usage examples
    • Get molecule identifiers
    • Inspect QM and MM structures
    • Manually compute DDE

@codecov-commenter
Copy link

codecov-commenter commented Oct 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.50%. Comparing base (216c208) to head (d92edb2).
Report is 31 commits behind head on yammbs-models.

Additional details and impacted files

@mattwthompson mattwthompson mentioned this pull request Oct 11, 2024
10 tasks
@mattwthompson mattwthompson marked this pull request as ready for review October 11, 2024 19:01
Copy link
Contributor

@ntBre ntBre left a comment

Choose a reason for hiding this comment

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

This looks great overall. I added some suggested fixes to very minor typos but otherwise happy to approve. I think the model_validate_json question I marked is the only potentially-functional issue, but if the script runs then it's clearly not a problem.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
run.py Outdated Show resolved Hide resolved
examples.ipynb Outdated Show resolved Hide resolved
@mattwthompson
Copy link
Member Author

Thanks for the review @ntBre! I will try to finish this up later today

@mattwthompson mattwthompson merged commit 2c43cee into yammbs-models Oct 17, 2024
9 checks passed
@mattwthompson mattwthompson deleted the update-docs branch November 25, 2024 18:37
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