Skip to content

Update docs#115

Merged
briling merged 21 commits intomasterfrom
update-docs
Nov 17, 2025
Merged

Update docs#115
briling merged 21 commits intomasterfrom
update-docs

Conversation

@briling
Copy link
Contributor

@briling briling commented Nov 7, 2025

Update all the docstrings and refactor some old code

@briling briling requested review from YAY-C and liam-o-marsh November 7, 2025 14:42
@briling
Copy link
Contributor Author

briling commented Nov 7, 2025

Hi all, here's the updated docstrings. I have also refactored some of the old code, e.g. unified how we compute moments of fitted density, get converged dm/mf, optimized some of the initial guesses. Also added qstack/mathutils/array.py with some helper functions which can be useful anyway (and might replace something I haven't noticed)

@briling briling mentioned this pull request Nov 7, 2025
This was referenced Nov 9, 2025
Copy link
Contributor

@liam-o-marsh liam-o-marsh left a comment

Choose a reason for hiding this comment

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

Some details in a bunch of places, but some of them are for me to check.

Comment on lines 22 to 23
- e (numpy ndarray): 1D array (nao,) of orbital eigenvalues.
- v (numpy ndarray): 2D array (nao, nao) of MO coefficients.
Copy link
Contributor

Choose a reason for hiding this comment

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

should be indented

- symmetrization_function (callable): Function for symmetrizing coefficients.
Args:
c (numpy ndarray): Density fitting coefficients (1D).
mol (pyscf Mole): Molecule object.
Copy link
Contributor

Choose a reason for hiding this comment

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

The inline Args and Returns should be indented further

Copy link
Contributor

Choose a reason for hiding this comment

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

(also I now remember there's another function that returns a callable without documenting it somewhere, probably around the regression part's kernel utils)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is solved in #117 i think

This was referenced Nov 13, 2025
@briling briling mentioned this pull request Nov 14, 2025
@briling briling requested a review from liam-o-marsh November 14, 2025 13:02
@briling briling merged commit f9f7065 into master Nov 17, 2025
8 checks passed
@briling briling deleted the update-docs branch November 17, 2025 19:26
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