Skip to content

Commit 0ead788

Browse files
committed
Update tutorials
1 parent 5c61bc7 commit 0ead788

31 files changed

Lines changed: 954 additions & 560 deletions

docs/docs/tutorials/ed-1.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{
44
"cell_type": "code",
55
"execution_count": null,
6-
"id": "ab0fa7f5",
6+
"id": "62acbe5c",
77
"metadata": {
88
"tags": [
99
"hide-in-docs"
@@ -205,11 +205,11 @@
205205
"# define aliases and then use them to create a constraint.\n",
206206
"project.analysis.aliases.create(\n",
207207
" label='biso_La',\n",
208-
" param=project.structures['lbco'].atom_sites['La'].b_iso,\n",
208+
" param=project.structures['lbco'].atom_sites['La'].adp_iso,\n",
209209
")\n",
210210
"project.analysis.aliases.create(\n",
211211
" label='biso_Ba',\n",
212-
" param=project.structures['lbco'].atom_sites['Ba'].b_iso,\n",
212+
" param=project.structures['lbco'].atom_sites['Ba'].adp_iso,\n",
213213
")\n",
214214
"project.analysis.constraints.create(expression='biso_Ba = biso_La')"
215215
]

docs/docs/tutorials/ed-10.ipynb

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{
44
"cell_type": "code",
55
"execution_count": null,
6-
"id": "dc88a9ac",
6+
"id": "7340ff71",
77
"metadata": {
88
"tags": [
99
"hide-in-docs"
@@ -105,7 +105,7 @@
105105
" fract_y=0.0,\n",
106106
" fract_z=0.0,\n",
107107
" wyckoff_letter='a',\n",
108-
" b_iso=0.5,\n",
108+
" adp_iso=0.5,\n",
109109
")"
110110
]
111111
},
@@ -176,7 +176,7 @@
176176
"outputs": [],
177177
"source": [
178178
"project.structures['ni'].cell.length_a.free = True\n",
179-
"project.structures['ni'].atom_sites['Ni'].b_iso.free = True"
179+
"project.structures['ni'].atom_sites['Ni'].adp_iso.free = True"
180180
]
181181
},
182182
{
@@ -207,7 +207,8 @@
207207
"outputs": [],
208208
"source": [
209209
"project.analysis.fit()\n",
210-
"project.analysis.display.fit_results()"
210+
"project.analysis.display.fit_results()\n",
211+
"project.plotter.plot_param_correlations()"
211212
]
212213
},
213214
{

docs/docs/tutorials/ed-10.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@
8383
# %%
8484
project.analysis.fit()
8585
project.analysis.display.fit_results()
86+
project.plotter.plot_param_correlations()
8687

8788
# %% [markdown]
8889
# ## Plot Measured vs Calculated

docs/docs/tutorials/ed-11.ipynb

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{
44
"cell_type": "code",
55
"execution_count": null,
6-
"id": "9736040b",
6+
"id": "a4f76dce",
77
"metadata": {
88
"tags": [
99
"hide-in-docs"
@@ -134,7 +134,7 @@
134134
" fract_y=0,\n",
135135
" fract_z=0,\n",
136136
" wyckoff_letter='a',\n",
137-
" b_iso=0.5,\n",
137+
" adp_iso=0.5,\n",
138138
")"
139139
]
140140
},
@@ -206,7 +206,7 @@
206206
"outputs": [],
207207
"source": [
208208
"project.structures['si'].cell.length_a.free = True\n",
209-
"project.structures['si'].atom_sites['Si'].b_iso.free = True\n",
209+
"project.structures['si'].atom_sites['Si'].adp_iso.free = True\n",
210210
"experiment.linked_phases['si'].scale.free = True"
211211
]
212212
},
@@ -239,7 +239,8 @@
239239
"outputs": [],
240240
"source": [
241241
"project.analysis.fit()\n",
242-
"project.analysis.display.fit_results()"
242+
"project.analysis.display.fit_results()\n",
243+
"project.plotter.plot_param_correlations()"
243244
]
244245
},
245246
{

docs/docs/tutorials/ed-11.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@
9696
# %%
9797
project.analysis.fit()
9898
project.analysis.display.fit_results()
99+
project.plotter.plot_param_correlations()
99100

100101
# %% [markdown]
101102
# ## Plot Measured vs Calculated

docs/docs/tutorials/ed-12.ipynb

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{
44
"cell_type": "code",
55
"execution_count": null,
6-
"id": "44960a4c",
6+
"id": "dfcbd6ef",
77
"metadata": {
88
"tags": [
99
"hide-in-docs"
@@ -137,7 +137,7 @@
137137
" fract_y=0,\n",
138138
" fract_z=0,\n",
139139
" wyckoff_letter='a',\n",
140-
" b_iso=1.0,\n",
140+
" adp_iso=1.0,\n",
141141
")\n",
142142
"project.structures['nacl'].atom_sites.create(\n",
143143
" label='Cl',\n",
@@ -146,7 +146,7 @@
146146
" fract_y=0.5,\n",
147147
" fract_z=0.5,\n",
148148
" wyckoff_letter='b',\n",
149-
" b_iso=1.0,\n",
149+
" adp_iso=1.0,\n",
150150
")"
151151
]
152152
},
@@ -256,8 +256,8 @@
256256
"outputs": [],
257257
"source": [
258258
"project.structures['nacl'].cell.length_a.free = True\n",
259-
"project.structures['nacl'].atom_sites['Na'].b_iso.free = True\n",
260-
"project.structures['nacl'].atom_sites['Cl'].b_iso.free = True"
259+
"project.structures['nacl'].atom_sites['Na'].adp_iso.free = True\n",
260+
"project.structures['nacl'].atom_sites['Cl'].adp_iso.free = True"
261261
]
262262
},
263263
{
@@ -288,7 +288,8 @@
288288
"outputs": [],
289289
"source": [
290290
"project.analysis.fit()\n",
291-
"project.analysis.display.fit_results()"
291+
"project.analysis.display.fit_results()\n",
292+
"project.plotter.plot_param_correlations()"
292293
]
293294
},
294295
{

docs/docs/tutorials/ed-12.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@
117117
# %%
118118
project.analysis.fit()
119119
project.analysis.display.fit_results()
120+
project.plotter.plot_param_correlations()
120121

121122
# %% [markdown]
122123
# ## Plot Measured vs Calculated

docs/docs/tutorials/ed-13.ipynb

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{
44
"cell_type": "code",
55
"execution_count": null,
6-
"id": "1ac207fe",
6+
"id": "25279ff1",
77
"metadata": {
88
"tags": [
99
"hide-in-docs"
@@ -497,8 +497,7 @@
497497
"\n",
498498
"The next set of parameters is needed to define the peak profile used\n",
499499
"in the fitting process. The peak profile describes the shape of the\n",
500-
"diffraction peaks. They include parameters for the broadening and\n",
501-
"asymmetry of the peaks.\n",
500+
"diffraction peaks.\n",
502501
"\n",
503502
"There are several commonly used peak profile functions:\n",
504503
"- **Gaussian**: Describes peaks with a symmetric bell-shaped curve,\n",
@@ -547,14 +546,14 @@
547546
"metadata": {},
548547
"outputs": [],
549548
"source": [
550-
"project_1.experiments['sim_si'].peak_profile_type = 'pseudo-voigt * ikeda-carpenter'\n",
549+
"project_1.experiments['sim_si'].peak_profile_type = 'jorgensen'\n",
551550
"project_1.experiments['sim_si'].peak.broad_gauss_sigma_0 = 69498\n",
552551
"project_1.experiments['sim_si'].peak.broad_gauss_sigma_1 = -55578\n",
553552
"project_1.experiments['sim_si'].peak.broad_gauss_sigma_2 = 14560\n",
554-
"project_1.experiments['sim_si'].peak.broad_mix_beta_0 = 0.0019\n",
555-
"project_1.experiments['sim_si'].peak.broad_mix_beta_1 = 0.0137\n",
556-
"project_1.experiments['sim_si'].peak.asym_alpha_0 = -0.0055\n",
557-
"project_1.experiments['sim_si'].peak.asym_alpha_1 = 0.0147"
553+
"project_1.experiments['sim_si'].peak.exp_decay_beta_0 = 0.0019\n",
554+
"project_1.experiments['sim_si'].peak.exp_decay_beta_1 = 0.0137\n",
555+
"project_1.experiments['sim_si'].peak.exp_rise_alpha_0 = -0.0055\n",
556+
"project_1.experiments['sim_si'].peak.exp_rise_alpha_1 = 0.0147"
558557
]
559558
},
560559
{
@@ -832,7 +831,7 @@
832831
" fract_y=0,\n",
833832
" fract_z=0,\n",
834833
" wyckoff_letter='a',\n",
835-
" b_iso=0.89,\n",
834+
" adp_iso=0.89,\n",
836835
")"
837836
]
838837
},
@@ -955,10 +954,10 @@
955954
"project_1.experiments['sim_si'].peak.broad_gauss_sigma_0.free = True\n",
956955
"project_1.experiments['sim_si'].peak.broad_gauss_sigma_1.free = True\n",
957956
"project_1.experiments['sim_si'].peak.broad_gauss_sigma_2.free = True\n",
958-
"project_1.experiments['sim_si'].peak.broad_mix_beta_0.free = True\n",
959-
"project_1.experiments['sim_si'].peak.broad_mix_beta_1.free = True\n",
960-
"project_1.experiments['sim_si'].peak.asym_alpha_0.free = True\n",
961-
"project_1.experiments['sim_si'].peak.asym_alpha_1.free = True"
957+
"project_1.experiments['sim_si'].peak.exp_decay_beta_0.free = True\n",
958+
"project_1.experiments['sim_si'].peak.exp_decay_beta_1.free = True\n",
959+
"project_1.experiments['sim_si'].peak.exp_rise_alpha_0.free = True\n",
960+
"project_1.experiments['sim_si'].peak.exp_rise_alpha_1.free = True"
962961
]
963962
},
964963
{
@@ -1443,14 +1442,14 @@
14431442
"source": [
14441443
"# # Create a reference to the peak profile parameters from the Si\n",
14451444
"sim_si_peak = project_1.experiments['sim_si'].peak\n",
1446-
"project_2.experiments['sim_lbco'].peak_profile_type = 'pseudo-voigt * ikeda-carpenter'\n",
1445+
"project_2.experiments['sim_lbco'].peak_profile_type = 'jorgensen'\n",
14471446
"project_2.experiments['sim_lbco'].peak.broad_gauss_sigma_0 = sim_si_peak.broad_gauss_sigma_0.value\n",
14481447
"project_2.experiments['sim_lbco'].peak.broad_gauss_sigma_1 = sim_si_peak.broad_gauss_sigma_1.value\n",
14491448
"project_2.experiments['sim_lbco'].peak.broad_gauss_sigma_2 = sim_si_peak.broad_gauss_sigma_2.value\n",
1450-
"project_2.experiments['sim_lbco'].peak.broad_mix_beta_0 = sim_si_peak.broad_mix_beta_0.value\n",
1451-
"project_2.experiments['sim_lbco'].peak.broad_mix_beta_1 = sim_si_peak.broad_mix_beta_1.value\n",
1452-
"project_2.experiments['sim_lbco'].peak.asym_alpha_0 = sim_si_peak.asym_alpha_0.value\n",
1453-
"project_2.experiments['sim_lbco'].peak.asym_alpha_1 = sim_si_peak.asym_alpha_1.value"
1449+
"project_2.experiments['sim_lbco'].peak.exp_decay_beta_0 = sim_si_peak.exp_decay_beta_0.value\n",
1450+
"project_2.experiments['sim_lbco'].peak.exp_decay_beta_1 = sim_si_peak.exp_decay_beta_1.value\n",
1451+
"project_2.experiments['sim_lbco'].peak.exp_rise_alpha_0 = sim_si_peak.exp_rise_alpha_0.value\n",
1452+
"project_2.experiments['sim_lbco'].peak.exp_rise_alpha_1 = sim_si_peak.exp_rise_alpha_1.value"
14541453
]
14551454
},
14561455
{
@@ -1775,7 +1774,7 @@
17751774
" fract_y=0,\n",
17761775
" fract_z=0,\n",
17771776
" wyckoff_letter='a',\n",
1778-
" b_iso=0.95,\n",
1777+
" adp_iso=0.95,\n",
17791778
" occupancy=0.5,\n",
17801779
")\n",
17811780
"project_2.structures['lbco'].atom_sites.create(\n",
@@ -1785,7 +1784,7 @@
17851784
" fract_y=0,\n",
17861785
" fract_z=0,\n",
17871786
" wyckoff_letter='a',\n",
1788-
" b_iso=0.95,\n",
1787+
" adp_iso=0.95,\n",
17891788
" occupancy=0.5,\n",
17901789
")\n",
17911790
"project_2.structures['lbco'].atom_sites.create(\n",
@@ -1795,7 +1794,7 @@
17951794
" fract_y=0.5,\n",
17961795
" fract_z=0.5,\n",
17971796
" wyckoff_letter='b',\n",
1798-
" b_iso=0.80,\n",
1797+
" adp_iso=0.80,\n",
17991798
")\n",
18001799
"project_2.structures['lbco'].atom_sites.create(\n",
18011800
" label='O',\n",
@@ -1804,7 +1803,7 @@
18041803
" fract_y=0.5,\n",
18051804
" fract_z=0.5,\n",
18061805
" wyckoff_letter='c',\n",
1807-
" b_iso=1.66,\n",
1806+
" adp_iso=1.66,\n",
18081807
")"
18091808
]
18101809
},
@@ -2224,10 +2223,10 @@
22242223
"project_2.experiments['sim_lbco'].peak.broad_gauss_sigma_0.free = True\n",
22252224
"project_2.experiments['sim_lbco'].peak.broad_gauss_sigma_1.free = True\n",
22262225
"project_2.experiments['sim_lbco'].peak.broad_gauss_sigma_2.free = True\n",
2227-
"project_2.experiments['sim_lbco'].peak.broad_mix_beta_0.free = True\n",
2228-
"project_2.experiments['sim_lbco'].peak.broad_mix_beta_1.free = True\n",
2229-
"project_2.experiments['sim_lbco'].peak.asym_alpha_0.free = True\n",
2230-
"project_2.experiments['sim_lbco'].peak.asym_alpha_1.free = True\n",
2226+
"project_2.experiments['sim_lbco'].peak.exp_decay_beta_0.free = True\n",
2227+
"project_2.experiments['sim_lbco'].peak.exp_decay_beta_1.free = True\n",
2228+
"project_2.experiments['sim_lbco'].peak.exp_rise_alpha_0.free = True\n",
2229+
"project_2.experiments['sim_lbco'].peak.exp_rise_alpha_1.free = True\n",
22312230
"\n",
22322231
"project_2.analysis.fit()\n",
22332232
"project_2.analysis.display.fit_results()\n",
@@ -2469,7 +2468,7 @@
24692468
" fract_y=0,\n",
24702469
" fract_z=0,\n",
24712470
" wyckoff_letter='a',\n",
2472-
" b_iso=0.89,\n",
2471+
" adp_iso=0.89,\n",
24732472
")\n",
24742473
"\n",
24752474
"# Assign Structure to Experiment\n",
@@ -2647,7 +2646,7 @@
26472646
],
26482647
"metadata": {
26492648
"jupytext": {
2650-
"cell_metadata_filter": "tags,title,-all",
2649+
"cell_metadata_filter": "title,tags,-all",
26512650
"main_language": "python",
26522651
"notebook_metadata_filter": "-all"
26532652
}

0 commit comments

Comments
 (0)