fixes to docs and docstrings

LemurPwned · Nov 19, 2023 · 1dec849 · 1dec849
1 parent 74ffdc1
commit 1dec849
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/cmtj/models/ensemble.py b/cmtj/models/ensemble.py
@@ -44,7 +44,7 @@ def mixed_lorentz(H, dH, Hr, Va, Vas):
     :param H: applied field in A/m
     :param dH: half width at half maximum in A/m
     :param Hr: resonance field in A/m
-    :param Vs: amplitude of symmetric Lorentzian
+    :param Va: amplitude of symmetric Lorentzian
     :param Vas: amplitude of antisymmetric Lorentzian
     """
     return symmetric_lorentz(H, dH, Hr, Va) + antisymmetric_lorentz(

diff --git a/cmtj/models/general_sb.py b/cmtj/models/general_sb.py
@@ -506,7 +506,7 @@ def solve(self,
         :param adam_tol: tolerance for the consecutive Adam minima.
         :param first_momentum_decay: constant for the first momentum.
         :param second_momentum_decay: constant for the second momentum.
-        :param pertubarion: the perturbation to use for the numerical gradient computation.
+        :param perturbation: the perturbation to use for the numerical gradient computation.
         :param ftol: tolerance for the frequency search. [numerical only]
         :param max_freq: maximum frequency to search for. [numerical only]
         :param force_single_layer: whether to force the computation of the frequencies

diff --git a/docs/physics/contributions.md b/docs/physics/contributions.md
@@ -213,5 +213,5 @@ device.setLayerAnisotropyDriver(
 The resulting anisotropy field is computed as:
 
 $$
-    \mathbf{H}_{\textrm{anis}} = \frac{2K_\textrm{u}}{t_{FM} \mu_0M_s}(\mathbf{m}\cdot\mathbf{a})\mathbf{a}
+    \mathbf{H}_{\textrm{anis}} = \frac{2K_\textrm{u}}{M_s}(\mathbf{m}\cdot\mathbf{a})\mathbf{a}
 $$
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -24,7 +24,7 @@ nav:
           - Plotting: api/plotting-reference.md
           - Procedures: api/procedures-reference.md
           - Parallel: api/parallel-reference.md
-          - Optimization: api/optmization-reference.md
+          - Optimization: api/optimization-reference.md
           - Ensemble models: api/ensemble-reference.md
           - Miscellanous: api/general-reference.md
       - Stack: gen-docs/stack.md