8000 Update documentation for ASE calculator by awvwgk · Pull Request #266 · tblite/tblite · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update documentation for ASE calculator #266

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

Merged
merged 2 commits into from
May 7, 2025
Merged

Conversation

awvwgk
Copy link
Member
@awvwgk awvwgk commented May 6, 2025

No description provided.

@awvwgk awvwgk requested a review from Copilot May 6, 2025 13:01
@awvwgk awvwgk added the python Related to the Python API or integration with Python label May 6, 2025
Copy link
Contributor
@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the documentation for the ASE calculator and refactors some of the internal API logic for improved clarity and consistency. Key changes include the addition of detailed usage examples, a unified solvation parameter replacing individual solvation keys, and refactored helper functions for creating the API calculator and retrieving charge/multiplicity.

Files not reviewed (1)
  • doc/users/ase.rst: Language not supported

Copy link
codecov bot commented May 6, 2025

Codecov Report

Attention: Patch coverage is 88.33333% with 7 lines in your changes missing coverage. Please review.

Project coverage is 71.22%. Comparing base (171274c) to head (7318bf8).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
python/tblite/ase.py 88.33% 7 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #266      +/-   ##
==========================================
+ Coverage   70.65%   71.22%   +0.56%     
==========================================
  Files         159      165       +6     
  Lines       20058    20653     +595     
  Branches     7133     7133              
==========================================
+ Hits        14172    14710     +538     
- Misses       2267     2324      +57     
  Partials     3619     3619              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

@awvwgk awvwgk force-pushed the ase/doc branch 2 times, most recently from 90785f3 to 83d0df2 Compare May 6, 2025 17:14
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@awvwgk awvwgk merged commit ac3a278 into tblite:main May 7, 2025
38 checks passed
@awvwgk awvwgk deleted the ase/doc branch May 7, 2025 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
python Related to the Python API or integration with Python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant
0