From b4b6a5013cdaca062ba149bf6e2c92abc57edfb3 Mon Sep 17 00:00:00 2001
From: Tammo van der Heide <vanderhe@uni-bremen.de>
Date: Fri, 2 Feb 2024 14:31:01 +0100
Subject: [PATCH] Switch from GradAMax to GradElem

---
 .readthedocs.yaml                             | 20 +++++++++++++++++++
 .../recipes/basics/firstcalc/dftb_in.hsd      |  2 +-
 docs/basics/firstcalc.rst                     | 11 +++++-----
 3 files changed, 26 insertions(+), 7 deletions(-)
 create mode 100644 .readthedocs.yaml

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 00000000..9db1b740
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+formats:
+  - pdf
+  - epub
+
+python:
+  install:
+    - requirements: requirements.txt
diff --git a/docs/_archives/recipes/basics/firstcalc/dftb_in.hsd b/docs/_archives/recipes/basics/firstcalc/dftb_in.hsd
index 2491a184..3f7f173a 100644
--- a/docs/_archives/recipes/basics/firstcalc/dftb_in.hsd
+++ b/docs/_archives/recipes/basics/firstcalc/dftb_in.hsd
@@ -12,7 +12,7 @@ Driver = GeometryOptimization {
   MovedAtoms = 1:-1
   MaxSteps = 100
   OutputPrefix = "geom.out"
-  Convergence {GradAMax = 1E-4}
+  Convergence {GradElem = 1E-4}
 }
 
 Hamiltonian = DFTB {
diff --git a/docs/basics/firstcalc.rst b/docs/basics/firstcalc.rst
index 02325f31..93cfc01a 100644
--- a/docs/basics/firstcalc.rst
+++ b/docs/basics/firstcalc.rst
@@ -37,7 +37,7 @@ looks as follows::
     MovedAtoms = 1:-1
     MaxSteps = 100
     OutputPrefix = "geom.out"
-    Convergence {GradAMax = 1E-4}
+    Convergence {GradElem = 1E-4}
   }
 
   Hamiltonian = DFTB {
@@ -137,7 +137,7 @@ In the current example ::
     MovedAtoms = 1:-1               # Move all atoms in the system
     MaxSteps = 100                  # Stop after maximal 100 steps
     OutputPrefix = "geom.out"       # Final geometry in geom.out.{xyz,gen}
-    Convergence {GradAMax = 1E-4}   # Stop if maximal force below 1E-4 H/a0
+    Convergence {GradElem = 1E-4}   # Stop if maximal force below 1E-4 H/a0
   }
 
 the molecule is relaxed using a rational function based optimiser. The
@@ -164,11 +164,11 @@ units by specifying a unit modifier before the equals sign. This is given in
 square brackets. For example instead of the original atomic units, you could
 have used ::
 
-  GradAMax [eV/AA] = 5.14e-3    # Force in Electronvolts/Angstrom
+  GradElem [eV/AA] = 5.14e-3    # Force in Electronvolts/Angstrom
 
 or ::
 
-  GradAMax [Electronvolt/Angstrom] = 5.14e-3
+  GradElem [Electronvolt/Angstrom] = 5.14e-3
 
 See the manual for the list of accepted modifiers and additional convergence
 criteria supported by the ``Convergence`` block.
@@ -632,10 +632,9 @@ set::
     MaxSteps = 100
     OutputPrefix = "geom.out"
     Convergence = {
-      GradAMax = 1E-4
+      GradElem = 1E-4
       Energy = 1.797693134862316E+308
       GradNorm = 1.797693134862316E+308
-      GradElem = 1.000000000000000E-004
       DispNorm = 1.797693134862316E+308
       DispElem = 1.797693134862316E+308
     }