Skip to content
Open
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
44 changes: 38 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,25 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
import sys, os
sys.path.append(os.path.abspath('extensions'))
import os
import sys

import sphinx_rtd_theme
sys.path.append(os.path.abspath('extensions'))

extensions = ['sphinxcontrib.bibtex', "sphinx_rtd_theme"]
extensions = [
"sphinxcontrib.bibtex",
"pydata_sphinx_theme",
"sphinx_copybutton",
"sphinx.ext.viewcode",
"sphinx.ext.mathjax",
"sphinx.ext.coverage",
]
bibtex_bibfiles = ["bibs/all.bib"]

copybutton_exclude = '.linenos, .gp, .go' # Don't copy line numbers, prompts, or outputs.
numfig = True

suppress_warnings = ["misc.highlighting_failure"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand All @@ -54,7 +63,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'pydata_sphinx_theme'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand All @@ -64,3 +73,26 @@
html_css_files = [
'custom.css',
]
html_theme_options = {
"logo": {
"alt_text": "QMCPACK",
"image_dark": "figs/QMCPACK_logo.png",
"image_light": "figs/QMCPACK_logo.png",
},
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/QMCPACK/qmcpack",
"icon": "fa-brands fa-github",
},
],
"navbar_end": [
"search-button",
"theme-switcher",
"navbar-icon-links"
],
"show_toc_level": 3,
"show_nav_level": 4,
"navigation_depth": 6,
"secondary_sidebar_items": ["page-toc"],
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions docs/contributing/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _contrib-and-devel:

Contributing
============

.. toctree::
:maxdepth: 2

contributing
design_features
unit_testing
integration_tests
github_actions
developing
external_tools
File renamed without changes.
File renamed without changes.
40 changes: 5 additions & 35 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,43 +13,13 @@ User's Guide and Developer's Manual


.. toctree::
:maxdepth: 2
:maxdepth: 3
:caption: Contents:

introduction
features
citing
performance_portable
installation
running
units
input_overview
simulationcell
intro_wavefunction
hamiltonianobservable
methods
output_overview
analyzing
LCAO
sCI
spin_orbit
afqmc
examples
lab_qmc_statistics
lab_qmc_basics
lab_advanced_molecules
lab_condensed_matter
lab_excited
lab_afqmc
additional_tools
external_tools
contributing
unit_testing
integration_tests
github_actions
running_docker
design_features
developing
introduction/index
user_guide/index
labs/index
contributing/index
bibliography
appendices

Expand Down
File renamed without changes.
File renamed without changes.
13 changes: 13 additions & 0 deletions docs/introduction/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. _intro:

Introduction
============

.. toctree::
:maxdepth: 2

introduction
features
methods
performance_portable
citing
File renamed without changes.
File renamed without changes.
16 changes: 0 additions & 16 deletions docs/lab_afqmc.rst

This file was deleted.

15 changes: 15 additions & 0 deletions docs/labs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _labs:

Labs
====


.. toctree::
:maxdepth: 2

lab_qmc_statistics
lab_qmc_basics
lab_advanced_molecules
lab_condensed_matter
lab_excited
lab_afqmc
File renamed without changes.
16 changes: 16 additions & 0 deletions docs/labs/lab_afqmc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. _lab-afqmc:

AFQMC Tutorials
===============

Below we will run through some full AFQMC workflow examples. The necessary scripts can be
found in the ``qmcpack/examples/afqmc`` directory.

.. include:: ../../examples/afqmc/01-neon_atom/README.rst
.. include:: ../../examples/afqmc/02-neon_frozen_core/README.rst
.. include:: ../../examples/afqmc/03-carbon_triplet_uhf/README.rst
.. include:: ../../examples/afqmc/04-N2_nomsd/README.rst
.. include:: ../../examples/afqmc/05-N2_phmsd/README.rst
.. include:: ../../examples/afqmc/06-methane_converge_back_prop/README.rst
.. include:: ../../examples/afqmc/07-diamond_2x2x2_supercell/README.rst
.. include:: ../../examples/afqmc/08-diamond_2x2x2_kpoint_sym/README.rst
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 4 additions & 2 deletions docs/requirements.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Specify inequalities for versions; no stronger dependencies known
sphinx>=7.2.6
sphinx_rtd_theme>=2.0.0
sphinx>=8.0.0
pydata_sphinx_theme>=0.17.1
sphinxcontrib-bibtex>=2.6.2
sphinx-design>=0.6.1
sphinx-copybutton>=0.5.2
48 changes: 32 additions & 16 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,29 +1,33 @@
#
# This file is autogenerated by pip-compile with Python 3.12
# by the following command:
#
# pip-compile requirements.in
#
# This file was autogenerated by uv via the following command:
# uv pip compile requirements.in -o requirements.txt
accessible-pygments==0.0.5
# via pydata-sphinx-theme
alabaster==1.0.0
# via sphinx
babel==2.18.0
# via sphinx
# via
# pydata-sphinx-theme
# sphinx
beautifulsoup4==4.15.0
# via pydata-sphinx-theme
certifi==2026.1.4
# via requests
charset-normalizer==3.4.4
# via requests
docutils==0.22.4
# via
# pybtex-docutils
# pydata-sphinx-theme
# sphinx
# sphinx-rtd-theme
# sphinxcontrib-bibtex
idna==3.15
# via requests
imagesize==1.4.1
# via sphinx
jinja2==3.1.6
# via sphinx
# via
# pydata-sphinx-theme
# sphinx
latexcodec==3.0.1
# via pybtex
markupsafe==3.0.3
Expand All @@ -36,23 +40,35 @@ pybtex==0.25.1
# sphinxcontrib-bibtex
pybtex-docutils==1.0.3
# via sphinxcontrib-bibtex
pydata-sphinx-theme==0.21.0
# via -r requirements.in
pygments==2.20.0
# via sphinx
# via
# accessible-pygments
# pydata-sphinx-theme
# sphinx
pyyaml==6.0.3
# via pybtex
requests==2.33.0
# via sphinx
# via
# pydata-sphinx-theme
# sphinx
roman-numerals==4.1.0
# via sphinx
snowballstemmer==3.0.1
# via sphinx
soupsieve==2.9.2
# via beautifulsoup4
sphinx==9.1.0
# via
# -r requirements.in
# sphinx-rtd-theme
# pydata-sphinx-theme
# sphinx-copybutton
# sphinx-design
# sphinxcontrib-bibtex
# sphinxcontrib-jquery
sphinx-rtd-theme==3.1.0
sphinx-copybutton==0.5.2
# via -r requirements.in
sphinx-design==0.7.0
# via -r requirements.in
sphinxcontrib-applehelp==2.0.0
# via sphinx
Expand All @@ -62,13 +78,13 @@ sphinxcontrib-devhelp==2.0.0
# via sphinx
sphinxcontrib-htmlhelp==2.1.0
# via sphinx
sphinxcontrib-jquery==4.1
# via sphinx-rtd-theme
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==2.0.0
# via sphinx
sphinxcontrib-serializinghtml==2.0.0
# via sphinx
typing-extensions==4.16.0
# via beautifulsoup4
urllib3==2.7.0
# via requests
File renamed without changes.
File renamed without changes.
File renamed without changes.
12 changes: 12 additions & 0 deletions docs/user_guide/advanced_guide/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _advanced-guide:

Advanced User Guide
===================

.. toctree::
:maxdepth: 2

afqmc
LCAO
sCI
spin_orbit
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ Estimators are generally not accumulated during wavefunction optimization sectio
``estimator`` factory element:

+------------------+----------------------+
| parent elements: | ``estimators`` |
| parent elements: | ``estimators`` |
+------------------+----------------------+
| type selector: | ``type`` attribute |
+------------------+----------------------+
Expand Down
21 changes: 21 additions & 0 deletions docs/user_guide/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. _user-guide:

User Guide
==========

.. toctree::
:maxdepth: 2

installation
input_overview
simulationcell
intro_wavefunction
hamiltonianobservable
running
running_docker
output_overview
analyzing
examples
units
additional_tools
advanced_guide/index
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ Attribute:

``radfunc`` element:
attributes for ``type`` = *"Gaussian"*:
``TBDoc``
``TBDoc``

.. _spo-hybrid:

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading