Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wpreimes committed Jan 20, 2022
1 parent cb43e20 commit 44c2c4f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 13 deletions.
8 changes: 1 addition & 7 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,11 @@ version: 2
sphinx:
configuration: docs/conf.py

formats:
- pdf

submodules:
include: all

conda:
environment: environment.yml

python:
version: 3.8
version: 3.7
install:
- method: pip
path: .
16 changes: 10 additions & 6 deletions docs/examples/triple_collocation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -93,19 +93,23 @@
"\n",
"Estimation of the error variances from the covariances of the datasets (e.g. $\\sigma_{XY}$ for the covariance between $x$ and $y$) is done using the following formula:\n",
"\n",
"$\\sigma_{\\varepsilon_x}^2 = \\sigma_{X}^2 - \\frac{\\sigma_{XY}\\sigma_{XZ}}{\\sigma_{YZ}}\\\\\n",
"\\sigma_{\\varepsilon_y}^2 = \\sigma_{Y}^2 - \\frac{\\sigma_{YX}\\sigma_{YZ}}{\\sigma_{XZ}}\\\\\n",
"\\sigma_{\\varepsilon_z}^2 = \\sigma_{Z}^2 - \\frac{\\sigma_{ZY}\\sigma_{ZX}}{\\sigma_{YX}}$\n",
"$\\sigma_{\\varepsilon_x}^2 = \\sigma_{X}^2 - \\frac{\\sigma_{XY}\\sigma_{XZ}}{\\sigma_{YZ}}$\n",
"\n",
"$\\sigma_{\\varepsilon_y}^2 = \\sigma_{Y}^2 - \\frac{\\sigma_{YX}\\sigma_{YZ}}{\\sigma_{XZ}}$\n",
"\n",
"$\\sigma_{\\varepsilon_z}^2 = \\sigma_{Z}^2 - \\frac{\\sigma_{ZY}\\sigma_{ZX}}{\\sigma_{YX}}$\n",
"\n",
"$\\beta$ can also be estimated from the covariances:\n",
"\n",
"$\\beta_x = 1 \\quad \\quad \\quad \\beta_y = \\frac{\\sigma_{XZ}}{\\sigma_{YZ}} \\quad \\quad \\quad \\beta_z=\\frac{\\sigma_{XY}}{\\sigma_{ZY}}$\n",
"\n",
"The signal to noise ratio (SNR) is also calculated from the variances and covariances:\n",
"\n",
"$\\text{SNR}_X[dB] = -10\\log\\left(\\frac{\\sigma_{X}^2\\sigma_{YZ}}{\\sigma_{XY}\\sigma_{XZ}}-1\\right)\\\\\n",
"\\text{SNR}_Y[dB] = -10\\log\\left(\\frac{\\sigma_{Y}^2\\sigma_{XZ}}{\\sigma_{YX}\\sigma_{YZ}}-1\\right)\\\\\n",
"\\text{SNR}_Z[dB] = -10\\log\\left(\\frac{\\sigma_{Z}^2\\sigma_{XY}}{\\sigma_{ZX}\\sigma_{ZY}}-1\\right)$\n",
"$\\text{SNR}_X[dB] = -10\\log\\left(\\frac{\\sigma_{X}^2\\sigma_{YZ}}{\\sigma_{XY}\\sigma_{XZ}}-1\\right)$\n",
"\n",
"$\\text{SNR}_Y[dB] = -10\\log\\left(\\frac{\\sigma_{Y}^2\\sigma_{XZ}}{\\sigma_{YX}\\sigma_{YZ}}-1\\right)$\n",
"\n",
"$\\text{SNR}_Z[dB] = -10\\log\\left(\\frac{\\sigma_{Z}^2\\sigma_{XY}}{\\sigma_{ZX}\\sigma_{ZY}}-1\\right)$\n",
"\n",
"It is given in dB to make it symmetric around zero. If the value is zero it means that the signal variance and the noise variance are equal. +3dB means that the signal variance is twice as high as the noise variance.\n",
"\n",
Expand Down

0 comments on commit 44c2c4f

Please sign in to comment.