Skip to content

Commit 5b6cbe1

Browse files
committed
Improves clarity in tutorials
1 parent eadf3f0 commit 5b6cbe1

8 files changed

+379
-322
lines changed

tutorials/advanced_joint-fit_pd-neut-xray-cwl_PbSO4.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# %% [markdown]
2-
# # Joint Fit (Advanced)
2+
# # Standard Diffraction: PbSO4, NPD and XRD
33
#
44
# This example demonstrates a flexible and advanced use of the
55
# EasyDiffraction library by explicitly creating and configuring objects.
@@ -20,7 +20,7 @@
2020
# %% [markdown]
2121
# ## Define Sample Model
2222
#
23-
# This section explains how to add sample models and modify their parameters.
23+
# This section shows how to add sample models and modify their parameters.
2424
#
2525
# ### Create Sample Model
2626

@@ -55,7 +55,7 @@
5555
# %% [markdown]
5656
# ## Define Experiments
5757
#
58-
# This section explains how to add experiments, configure their parameters, and
58+
# This section shows how to add experiments, configure their parameters, and
5959
# link the sample models defined in the previous step.
6060
#
6161
# ### Experiment 1: npd
@@ -96,13 +96,13 @@
9696
# #### Set Background
9797

9898
# %% [markdown]
99-
# Select Background Type
99+
# Select background type.
100100

101101
# %%
102102
expt1.background_type = 'line-segment'
103103

104104
# %% [markdown]
105-
# Add Background Points
105+
# Add background points.
106106

107107
# %%
108108
for x, y in [
@@ -162,13 +162,13 @@
162162
# #### Set Background
163163

164164
# %% [markdown]
165-
# Select Background Type
165+
# Select background type.
166166

167167
# %%
168168
expt2.background_type = 'chebyshev polynomial'
169169

170170
# %% [markdown]
171-
# Add Background Points
171+
# Add background points.
172172

173173
# %%
174174
for x, y in [
@@ -190,7 +190,7 @@
190190
# %% [markdown]
191191
# ## Define Project
192192
#
193-
# The project object manages the sample model, experiments, and
193+
# The project object is used to manage the sample model, experiment, and
194194
# analysis.
195195
#
196196
# ### Create Project
@@ -214,8 +214,8 @@
214214
# %% [markdown]
215215
# ## Analysis
216216
#
217-
# This section explains the analysis process, including how to set
218-
# up calculators and fit models.
217+
# This section shows the analysis process, including how to set up
218+
# calculation and fitting engines.
219219
#
220220
# ### Set Calculator
221221

@@ -237,15 +237,15 @@
237237
# %% [markdown]
238238
# ### Set Fitting Parameters
239239
#
240-
# Set sample model parameters to be refined
240+
# Set sample model parameters to be refined.
241241

242242
# %%
243243
model.cell.length_a.free = True
244244
model.cell.length_b.free = True
245245
model.cell.length_c.free = True
246246

247247
# %% [markdown]
248-
# Set experiment parameters to be refined
248+
# Set experiment parameters to be refined.
249249

250250
# %%
251251
expt1.linked_phases['pbso4'].scale.free = True
@@ -277,7 +277,7 @@
277277
project.analysis.fit()
278278

279279
# %% [markdown]
280-
# ### Show Results
280+
# ### Plot Measured vs Calculated
281281

282282
# %%
283283
project.plot_meas_vs_calc(expt_name='npd',

0 commit comments

Comments
 (0)