Skip to content

Add documentation for rec-space kenetic energy preconditioning#18

Merged
JacekDziedzic merged 3 commits intoonetep-devel:mainfrom
Chengcheng-Xiao:auto_k_precond
Dec 18, 2025
Merged

Add documentation for rec-space kenetic energy preconditioning#18
JacekDziedzic merged 3 commits intoonetep-devel:mainfrom
Chengcheng-Xiao:auto_k_precond

Conversation

@Chengcheng-Xiao
Copy link
Contributor

@Chengcheng-Xiao Chengcheng-Xiao commented Dec 10, 2025

As title. This PR also updates the version and release to 8.0.0!

Here is a compiled PDF version: ONETEP_Documentation.pdf

Tagging @nickhine

@JacekDziedzic
Copy link
Contributor

Thanks so much, @Chengcheng-Xiao, that's very helpful.

I only have a few very minor comments:

s/by default use/by default uses/
s/where,/where/

In the section header "3.17.1" replace k_0 with an actual subscript.

Next page:

s/kintetic/kinetic/
s/upreconditioning/preconditioning/
s/Basic string/Basic, string/ (twice)

k_zero is "physical", not "float". In the description change k0 to $k_0$.
In the description for precond_array change k0 to $k_0$.

@Chengcheng-Xiao
Copy link
Contributor Author

@JacekDziedzic Thanks, done!

@JacekDziedzic JacekDziedzic merged commit ed90ef1 into onetep-devel:main Dec 18, 2025
2 checks passed
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.

2 participants