docs for gauss calc

calc/GaussCalculator.md

@@ -1,14 +1,15 @@
 # Gauss calculator tool formulas
 
-*Gauss Calculator Tool* computes some free parameters of the Gaussian beam, when changing one of its parameters and fixing some others. As it is not possible to make all the parameters to be free, we introduce two fixing modes called *Lock waist* and *Lock front*.
+*Gauss Calculator Tool* computes some free parameters of the Gaussian beam when changing one of its parameters and fixing some others. As it is not possible to make all the parameters to be free, we introduce two fixing modes called *Lock waist* and *Lock front*.
 
-- Lock waist - find such values of free parameters at which the beam waist $w_0$ stays constant when one of parameters changes.
-- Lock front - find such values of free parameters at which the wavefront ROC $R$ and the beam radius $w$ at some axial distance $z$ stay constant when one of parameters changes.
+- Lock waist - find such values of free parameters at which the beam waist $w_0$ stays constant when one of the parameters changes.
+- Lock front - find such values of free parameters at which the wavefront ROC $R$ and the beam radius $w$ at some axial distance $z$ stay constant when one of the parameters changes.
 
 Quadratic equations have two solutions and we have to define a way to point out which solution to take. So the tool has one additional parameter - zone - which can be *Near zone* or *Far zone*.
 
 Test values for the tool are calculated via script `GaussCalculator.py`.
 
+Use these formulas for the documentatin page `../help/calc_gauss.rst`.
 
 ## Change waist $w_0$
 
@@ -19,7 +20,7 @@ $$ z_0 = \frac{\pi w_0^2}{M^2 \lambda}  $$
 
 $$ V_s = \frac{M^2 \lambda}{\pi w_0}  $$
 
-$$ w = w_0 \sqrt{ 1 + \bigg( \frac{z}{z_0} \bigg)^2 } $$ 
+$$ w = w_0 \sqrt{ 1 + \bigg( \frac{z}{z_0} \bigg)^2 } $$
 
 $$ R = z \Bigg[ 1 + \bigg( \frac{z_0}{z} \bigg)^2 \Bigg] $$
 
@@ -50,7 +51,7 @@ $$ M^2 = \frac{ \pi w_0^2 }{ \lambda z_0 }  $$
 
 $$ V_s = \frac{M^2 \lambda}{\pi w_0}  $$
 
-$$ w = w_0 \sqrt{ 1 + \bigg( \frac{z}{z_0} \bigg)^2 } $$ 
+$$ w = w_0 \sqrt{ 1 + \bigg( \frac{z}{z_0} \bigg)^2 } $$
 
 $$ R = z \Bigg[ 1 + \bigg( \frac{z_0}{z} \bigg)^2 \Bigg] $$
 
@@ -79,7 +80,7 @@ $$ M^2 = \frac{ \pi w_0 V_s } \lambda $$
 
 $$ z_0 = \frac{\pi w_0^2}{M^2 \lambda}  $$
 
-$$ w = w_0 \sqrt{ 1 + \bigg( \frac{z}{z_0} \bigg)^2 } $$ 
+$$ w = w_0 \sqrt{ 1 + \bigg( \frac{z}{z_0} \bigg)^2 } $$
 
 $$ R = z \Bigg[ 1 + \bigg( \frac{z_0}{z} \bigg)^2 \Bigg] $$
 
@@ -96,7 +97,7 @@ $$ z_0 = \sqrt{z (R - z)}  $$
 
 $$ w_0 = \frac{w}{\sqrt{ 1 + \big( z/z_0 \big)^2} } $$
 
-$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$ 
+$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$
 
 
 ## Change axial distance $z$
@@ -107,7 +108,7 @@ $$ z_0 = \frac{\pi w_0^2}{M^2 \lambda}  $$
 
 $$ V_s = \frac{M^2 \lambda}{\pi w_0}  $$
 
-$$ w = w_0 \sqrt{ 1 + \bigg( \frac{z}{z_0} \bigg)^2 } $$ 
+$$ w = w_0 \sqrt{ 1 + \bigg( \frac{z}{z_0} \bigg)^2 } $$
 
 $$ R = z \Bigg[ 1 + \bigg( \frac{z_0}{z} \bigg)^2 \Bigg] $$
 
@@ -119,7 +120,7 @@ $$ z_0 = \sqrt{z (R - z)}  $$
 
 $$ w_0 = \frac{w}{\sqrt{ 1 + \big( z/z_0 \big)^2} } $$
 
-$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$ 
+$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$
 
 $$ V_s = \frac{M^2 \lambda}{\pi w_0}  $$
 
@@ -133,7 +134,7 @@ $$ z_0 = \frac{\pi w_0^2}{M^2 \lambda}  $$
 
 $$ V_s = \frac{M^2 \lambda}{\pi w_0}  $$
 
-$$ w = w_0 \sqrt{ 1 + \bigg( \frac{z}{z_0} \bigg)^2 } $$ 
+$$ w = w_0 \sqrt{ 1 + \bigg( \frac{z}{z_0} \bigg)^2 } $$
 
 $$ R = z \Bigg[ 1 + \bigg( \frac{z_0}{z} \bigg)^2 \Bigg] $$
 
@@ -160,7 +161,7 @@ Find beam quality parameter $M^2$ giving specified beam radius at the same axial
 
 $$ z_0 = \frac{z w_0}{\sqrt{w^2 - w_0^2}} $$
 
-$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$ 
+$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$
 
 $$ V_s = \frac{M^2 \lambda}{\pi w_0}  $$
 
@@ -175,7 +176,7 @@ $$ z_0 = \sqrt{z (R - z)}  $$
 
 $$ w_0 = \frac{w}{\sqrt{ 1 + \big( z/z_0 \big)^2} } $$
 
-$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$ 
+$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$
 
 $$ V_s = \frac{M^2 \lambda}{\pi w_0}  $$
 
@@ -189,11 +190,11 @@ Find beam quality parameter $M^2$ giving specified ROC at the same axial distanc
 
 $$ z_0 = \sqrt{z (R - z)}  $$
 
-$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$ 
+$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$
 
 $$ V_s = \frac{M^2 \lambda}{\pi w_0}  $$
 
-$$ w = w_0 \sqrt{ 1 + \bigg( \frac{z}{z_0} \bigg)^2 } $$ 
+$$ w = w_0 \sqrt{ 1 + \bigg( \frac{z}{z_0} \bigg)^2 } $$
 
 $$ q^{-1} = \frac 1 R + i \frac{\lambda}{\pi w^2} $$
 
@@ -204,7 +205,7 @@ $$ z_0 = \sqrt{z (R - z)}  $$
 
 $$ w_0 = \frac{w}{\sqrt{ 1 + \big( z/z_0 \big)^2} } $$
 
-$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$ 
+$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$
 
 $$ V_s = \frac{M^2 \lambda}{\pi w_0}  $$
 
@@ -225,7 +226,7 @@ $$ z = R \Bigg[ 1 - \bigg( \frac{w_0}{w} \bigg)^2 \Bigg] $$
 
 $$ z_0 = \sqrt{z (R - z)}  $$
 
-$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$ 
+$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$
 
 $$ V_s = \frac{M^2 \lambda}{\pi w_0}  $$
 
@@ -235,7 +236,7 @@ $$ z_0 = \sqrt{z (R - z)}  $$
 
 $$ w_0 = \frac{w}{\sqrt{ 1 + \big( z/z_0 \big)^2} } $$
 
-$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$ 
+$$ M^2 = \frac{\pi w_0^2}{z_0 \lambda} $$
 
 $$ V_s = \frac{M^2 \lambda}{\pi w_0}  $$
 

help/README.md

@@ -35,3 +35,11 @@ make.bat
 ```
 
 Target documentation is in `../out` directory.
+
+## Notes
+
+### Formulas
+
+As the documentation contains a notable amount of physical formulas, they should be inserted as pictures. Qt Assistant uses `QTextDocument` to display help pages, and it has fewer abilities comparing to real browsers. Also, Assistant can't run JavaScript code. So pictures for formulas is the only possibility to display them. The page `render_formula.html` used to render TeX syntax into SVG using well known [MaxJax](https://github.com/mathjax/MathJax) library. PNG images then saved using print-screen operation, no automation for this process yet.
+
+There also a number of ODF files that are LibreOffice Math formulas. They should be considered as deprecated and gradually replaced. Reasons are Math uses its own syntax instead of conventional TeX, and its rendered formulas do not have such nice appearance as those rendered by MathJax.