conquest/docs
Augustin Lu c13e121150
Merge pull request #258 from AugustinLu/f-xsf-xyz-write-frequency
Implementation of two additional keywords to control the frequency with which the XSF and XYZ coordinate files are written.
2023-11-07 18:43:18 +09:00
..
tutorials Updates for output level zero 2022-09-19 16:22:36 +01:00
MDPlot.png Relocate all documentation files into docs/ 2020-02-27 08:32:53 +00:00
Makefile Relocate all documentation files into docs/ 2020-02-27 08:32:53 +00:00
README.md Tidying output in general (time, date, electrons) 2022-09-19 16:22:36 +01:00
ase-conquest.rst a few modifications on headings (2) 2023-08-01 16:28:29 +02:00
basissets.rst Add overview of PAO generation procedure 2022-12-15 15:56:53 +09:00
compare.jpg Relocate all documentation files into docs/ 2020-02-27 08:32:53 +00:00
conf.py On-going updates to output reworking (cg, sqnm, md) 2022-09-23 13:34:37 +01:00
convergence.rst Relocate all documentation files into docs/ 2020-02-27 08:32:53 +00:00
elec_struc.rst Polishing manual entry for polarisation 2023-06-23 08:28:52 +01:00
errors.rst Relocate all documentation files into docs/ 2020-02-27 08:32:53 +00:00
examples.rst Relocate all documentation files into docs/ 2020-02-27 08:32:53 +00:00
ext-tools.rst added documentation for ASE+CONQUEST 2023-08-01 16:08:44 +02:00
faq.rst Relocate all documentation files into docs/ 2020-02-27 08:32:53 +00:00
generating_paos.rst Add overview of PAO generation procedure 2022-12-15 15:56:53 +09:00
groundstate.rst added explanation of padH in manual 2023-11-04 02:28:14 +09:00
index.rst Add documentation on energy, forces and stresses 2023-08-02 12:20:37 +01:00
input-output.rst Updates to manual and further output tweaks 2022-10-17 14:40:22 +01:00
input_tags.rst Merge pull request #258 from AugustinLu/f-xsf-xyz-write-frequency 2023-11-07 18:43:18 +09:00
installing.rst Address code review comments relating to documentation. 2023-10-04 12:00:40 +01:00
moldyn.rst Relocate all documentation files into docs/ 2020-02-27 08:32:53 +00:00
post-proc.rst Added documentation 2023-06-30 14:14:33 +01:00
quick-overview.rst Relocate all documentation files into docs/ 2020-02-27 08:32:53 +00:00
rdf.jpg Relocate all documentation files into docs/ 2020-02-27 08:32:53 +00:00
references.bib Add documentation on energy, forces and stresses 2023-08-02 12:20:37 +01:00
requirements.txt On-going updates to output reworking (cg, sqnm, md) 2022-09-23 13:34:37 +01:00
stats.jpg Relocate all documentation files into docs/ 2020-02-27 08:32:53 +00:00
strucrelax.rst Updates to cell optimisation 2023-01-11 14:59:18 +00:00
theory-md.rst Relocate all documentation files into docs/ 2020-02-27 08:32:53 +00:00
theory-strucrelax.rst Relocate all documentation files into docs/ 2020-02-27 08:32:53 +00:00
theory_energy_force_stress.rst Add documentation on energy, forces and stresses 2023-08-02 12:20:37 +01:00
why-conquest.rst Documentation for projected DOS 2023-05-09 15:02:11 +01:00

README.md

The documentation for CONQUEST and associated utilities is stored here.

You can build the documentation simply:

  • make html will make HTML documentation (found in _build/html)
  • make PDF will make one PDF file using LaTeX (if installed)

The documentation is also available on ReadTheDocs.