lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-03-16 23:30:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: typos in example notebooks corrected.

Browse source
This commit is contained in:
Fabian Joswig 2022-07-21 13:29:27 +01:00
parent aa04a55bda
commit 62814c1fff
2 changed files with 6 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
examples/01_basic_example.ipynb
View file

@ -11,7 +11,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Import pyerrors, as well as autograd wrapped numpy and matplotlib."
"Import numpy, matplotlib and pyerrors."
]
},
{
@ -91,7 +91,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"`pyerrors` overloads all basic math operations, the user can work with these `Obs` as if they were real numbers. The proper resampling is performed in the background via automatic differentiation."
"`pyerrors` overloads all basic math operations, the user can work with these `Obs` as if they were real numbers. The proper error propagation is performed in the background via automatic differentiation."
]
},
{
@ -179,7 +179,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"This figure shows the windowsize dependence of the integrated autocorrelation time. The red vertical line signalizes the window chosen by the automatic windowing procedure with $S=2.0$.\n",
"This figure shows the windowsize dependence of the integrated autocorrelation time. The vertical line signalizes the window chosen by the automatic windowing procedure with $S=2.0$.\n",
"Choosing a larger windowsize would not significantly alter $\\tau_\\text{int}$, so everything seems to be correct here."
]
},
@ -283,7 +283,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"We can now redo the error analysis and alter the value of S or attach a tail to the autocorrelation function to take into account long range autocorrelations"
"We can now redo the error analysis and alter the value of S or attach a tail to the autocorrelation function via the parameter `tau_exp` to take into account long range autocorrelations"
]
},
{

17
examples/02_correlators.ipynb
View file

@ -242,7 +242,7 @@
"id": "4a9d13b2",
"metadata": {},
"source": [
"We can also use the priodicity of the lattice in order to obtain the cosh effective mass"
"We can also use the periodicity of the lattice in order to obtain the cosh effective mass"
]
},
{
@ -387,8 +387,7 @@
"source": [
"## Missing Values \n",
"\n",
"Apart from the build-in functions, there is another reason, why one should use a **Corr** instead of a list of **Obs**. \n",
"Missing values are handled for you. \n",
"Apart from the build-in functions, another benefit of using ``Corr`` objects is that they can handle missing values. \n",
"We will create a second correlator with missing values. "
]
},
@ -459,18 +458,6 @@
"The important thing is that, whatever you do, correlators keep their length **T**. So there will never be confusion about how you count timeslices. You can also take a plateau or perform a fit, even though some values might be missing."
]
},
{
"cell_type": "code",
"execution_count": 18,
"id": "f3c4609c",
"metadata": {},
"outputs": [],
"source": [
"assert first_derivative.T == my_correlator.T == len(first_derivative.content) == len(my_correlator.content)\n",
"assert first_derivative.content[0] is None\n",
"assert first_derivative.content[-1] is None"
]
},
{
"cell_type": "markdown",
"id": "7fcbcac4",