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

Version prepartion + changelog, FAQ documentation #222

Open
wants to merge 42 commits into
base: develop
Choose a base branch
from

Conversation

jcoulter12
Copy link
Member

Summary of changes:

This PR is a bit more mixed than it should be -- however, it includes several small bugfixes that likely do not affect most users, several updates to versions of tooling and from C++17->20, and a few additions to the documentation.

This PR is primarily in service of moving to a more regular versioning pattern.

Minor bugfixes:

  • Minor bugfix to Wannier interpolation of band energies when ws_vec file from Wannier90 is used.
  • Minor bugfix to the phononLifetimes app -- in some materials, is was possible for a threshold discarding degenerate three phonon triplets based on energies was too loose, meaning real contributions were lost.

Tooling updates

  • Update google tests version to 1.14
  • Split git actions so that all compiler tests are only run during a PR rather than on each commit
  • Upgrade to C++ 20 std

Changes to the documentation:

  • Addition of contributors section to "About" page
  • New "FAQ and Performance Tips" page of the documentation
  • Add "Changelog" page, with a very long update since the 1.0 release
  • Update docs to reference the updated phoebe-qe patch to QE 7.3
  • Update docs to show version 1.1.0

Thanks also to user @TheoBardu for identifying and testing the fix to the phononLifetimes app issue.

jcoulter12 and others added 30 commits May 28, 2024 11:14
…ntu on push, but runs the previous full compiler check on PR
…to faq, update sphinx year and Phoebe version, a few other minor typo fixes to docs
Minor typo fix in epa tutorial
… patch which is no longer maintained. [ci skip]
@jcoulter12 jcoulter12 self-assigned this Aug 18, 2024
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.

1 participant