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

Improving README.md #44

Merged
merged 1 commit into from
Sep 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -152,3 +152,4 @@ anaconda-upload/*

# managlyph .abo files
*.abo
.vscode
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,20 @@ With PyQInt, the student can for example build their own Hartree-Fock routine.
Some common electronic structure routine, most notably the Hartree-Fock
algorithm, is also readily available.

> **Note**
> [!NOTE]
> Although PyQInt connects to a C++ backend, it is certainly not optimized for
> speed and might be (too) slow for anything outside of the calculation of the
> electronic structure of simple molecules.

> [!TIP]
> Interested in other **education** quantum chemical codes? Have a look at the packages below.
> * [PyDFT](https://github.com/ifilot/pydft) is a pure-Python density functional
> theory code, built on top of PyQInt.
> * [HFCXX](https://github.com/ifilot/hfcxx) is a full C++ code for performing
> Hartree-Fock calculations.
> * [DFTCXX](https://github.com/ifilot/dftcxx) is a full C++ code for performing
> Density Functional Theory Calculations.

## Documentation

PyQInt comes with detailed documentation and examples, which can be found
Expand All @@ -49,9 +58,11 @@ as well as the following geometric derivatives
- [x] Two-electron repulsion integral

PyQInt offers additional features such as
* Performing [restricted Hartree-Fock](https://en.wikipedia.org/wiki/Hartree%E2%80%93Fock_method)
* Performing [restricted
Hartree-Fock](https://en.wikipedia.org/wiki/Hartree%E2%80%93Fock_method)
calculations using [DIIS](https://en.wikipedia.org/wiki/DIIS)
* Calculation of [Crystal Orbital Hamilton Population](http://www.cohp.de/) coefficients
* Calculation of [Crystal Orbital Hamilton Population](http://www.cohp.de/)
coefficients
* Construction of localized orbitals using the [Boys-Foster
method](https://en.wikipedia.org/wiki/Localized_molecular_orbitals#Foster-Boys)
* Visualization of molecular orbitals
Expand Down
Loading