Skip to content

Commit a11198e

Browse files
committed
Further rewriting documentation
1 parent cea067a commit a11198e

4 files changed

Lines changed: 76 additions & 72 deletions

File tree

docs/becke_grid_analysis.rst

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -45,31 +45,4 @@ method.
4545
:linenos:
4646
:emphasize-lines: 14
4747

48-
.. image:: _static/img/user_interface/06-grid-points.png
49-
50-
Electron density and its gradient
51-
---------------------------------
52-
53-
The :class:`pydft.DFT` class exposes its internal matrices and a number of
54-
useful functions which we can readily use to interpret its operation. Let us
55-
start by generating a plot of the electron density using the method
56-
:meth:`pydft.DFT.get_density_at_points`.
57-
58-
.. literalinclude:: scripts/01-electron-density.py
59-
:language: python
60-
:linenos:
61-
:emphasize-lines: 25
62-
63-
Running the above script yields the electron density.
64-
65-
.. figure:: _static/img/user_interface/01-electron-density.png
66-
67-
Using largely the same code, we can also readily build the electron density
68-
gradient magnitude using :meth:`pydft.DFT.get_gradient_at_points`.
69-
70-
.. literalinclude:: scripts/02-electron-density-gradient.py
71-
:language: python
72-
:linenos:
73-
:emphasize-lines: 25
74-
75-
.. figure:: _static/img/user_interface/02-electron-density-gradient.png
48+
.. image:: _static/img/user_interface/06-grid-points.png

docs/exchange_correlation_functional_analysis.rst

Lines changed: 0 additions & 36 deletions
This file was deleted.

docs/index.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,14 @@ calculations using Gaussian Type Orbitals.
1313

1414
.. image:: _static/img/pydft_logo_full_512px.png
1515

16-
:program:`PyDFT` currently supports LDA and PBE
17-
exchange-correlation functionals. The purpose of :program:`PyDFT` is mainly to
18-
serve as an educational tool to explain the inner workings of a DFT
19-
calculation. This program is not intended for professional calculations. It is
20-
not particularly fast nor offers a lot of features that more mature
21-
open-source of commercial packages offer. It does offer a unique insight into
22-
a working code and a considerable effort was made in documenting everything.
16+
The primary purpose of :program:`PyDFT` is to serve as an educational tool that
17+
illustrates the inner workings of a density-functional theory calculation.
18+
Currently, :program:`PyDFT` supports LDA and PBE exchange-correlation
19+
functionals. While it is not intended to replace mature open-source or
20+
commercial electronic-structure packages, care has been taken to achieve
21+
reasonable performance within the constraints of a Python implementation. In
22+
addition, a strong emphasis has been placed on code clarity and comprehensive
23+
documentation, providing detailed insight into a fully working DFT code.
2324

2425
.. tip::
2526

@@ -45,7 +46,7 @@ submitted via the `github issue tracker
4546
orbital_visualization
4647
becke_grid_analysis
4748
hartree_potential_analysis
48-
exchange_correlation_functional_analysis
49+
scalar_field_analysis
4950
benchmarks
5051
community_guidelines
5152

docs/scalar_field_analysis.rst

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
Scalar field analysis
2+
=====================
3+
4+
.. contents:: Table of Contents
5+
:depth: 3
6+
7+
Once the electronic structure has been determined, a variety of scalar fields
8+
derived from the electron density can be analyzed and visualized. These fields
9+
provide insight into the spatial distribution of electronic properties and form
10+
the basis for interpreting exchange, correlation, and density-related
11+
quantities.
12+
13+
Electron density and its gradient
14+
---------------------------------
15+
16+
The :class:`pydft.DFT` class exposes its internal matrices and a number of
17+
useful functions which we can readily use to interpret its operation. Let us
18+
start by generating a plot of the electron density using the method
19+
:meth:`pydft.DFT.get_density_at_points`.
20+
21+
.. literalinclude:: scripts/01-electron-density.py
22+
:language: python
23+
:linenos:
24+
:emphasize-lines: 25
25+
26+
Running the above script yields the electron density.
27+
28+
.. figure:: _static/img/user_interface/01-electron-density.png
29+
30+
Using largely the same code, we can also readily build the electron density
31+
gradient magnitude using :meth:`pydft.DFT.get_gradient_at_points`.
32+
33+
.. literalinclude:: scripts/02-electron-density-gradient.py
34+
:language: python
35+
:linenos:
36+
:emphasize-lines: 25
37+
38+
.. figure:: _static/img/user_interface/02-electron-density-gradient.png
39+
40+
Exchange potential
41+
------------------
42+
43+
To construct the exchange potential at arbitrary grid points, we can use the
44+
script as shown below which uses the :meth:`pydft.MolecularGrid.get_exchange_potential_at_points`
45+
method.
46+
47+
.. literalinclude:: scripts/08-exchange-potential.py
48+
:language: python
49+
:linenos:
50+
:emphasize-lines: 13
51+
52+
.. image:: _static/img/user_interface/08-exchange-potential.png
53+
54+
Correlation potential
55+
---------------------
56+
57+
In a similar fashion as for the exchange potential, we can use the method
58+
:meth:`pydft.MolecularGrid.get_correlation_potential_at_points` to obtain the
59+
correlation potential field.
60+
61+
.. literalinclude:: scripts/08-correlation-potential.py
62+
:language: python
63+
:linenos:
64+
:emphasize-lines: 13
65+
66+
.. image:: _static/img/user_interface/08-correlation-potential.png

0 commit comments

Comments
 (0)