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

Change Molecule.nelec to the total number of electrons #72

Merged
merged 1 commit into from
Feb 5, 2024

Conversation

chmwzc
Copy link
Contributor

@chmwzc chmwzc commented Jan 22, 2024

This was done in response to feedback on Qibochem from my Dec 2023 RAP attachment students.

First, they asked what's .nso and .nelec: Documentation for these class attributes was missing.
Follow-up question: why are all the .n* attributes integers, except for .nelec, which is currently (nalpha, nbeta)?

Hence, I changed .nelec to the total number of electrons directly.

Also: Added documentation for some other Molecule class attributes that are potentially useful.

Add documentation for some Molecule class attributes too
Copy link

codecov bot commented Jan 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2718de5) 100.00% compared to head (ff9aaeb) 100.00%.
Report is 15 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #72   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           11        11           
  Lines          401       402    +1     
=========================================
+ Hits           401       402    +1     
Flag Coverage Δ
unittests 100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@chmwzc chmwzc added this to the Qibochem 0.0.2 milestone Jan 24, 2024
@chmwzc chmwzc added enhancement New feature or request documentation Improvements or additions to documentation labels Jan 24, 2024
@chmwzc chmwzc mentioned this pull request Jan 31, 2024
@damarkian damarkian requested review from TL231 and damarkian and removed request for TL231 February 5, 2024 22:22
@damarkian
Copy link
Contributor

This was done in response to feedback on Qibochem from my Dec 2023 RAP attachment students.

First, they asked what's .nso and .nelec: Documentation for these class attributes was missing. Follow-up question: why are all the .n* attributes integers, except for .nelec, which is currently (nalpha, nbeta)?

Hence, I changed .nelec to the total number of electrons directly.

Also: Added documentation for some other Molecule class attributes that are potentially useful.

.nelec is a tuple because pyscf made it so. It was just carried over.

I agree that it can be confusing. If we just use .nelec as the number of electrons, then we have to be careful that it remains so, and not overlap into .nso, which is the number of electrons in the active space.

Looks ok to me now.

@damarkian damarkian closed this Feb 5, 2024
@damarkian damarkian reopened this Feb 5, 2024
@damarkian damarkian merged commit 6eaca8a into main Feb 5, 2024
3 checks passed
@damarkian damarkian deleted the mol-updates branch February 5, 2024 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants