{ "cells": [ { "cell_type": "code", "execution_count": 1, "id": "0", "metadata": { "execution": { "iopub.execute_input": "2026-08-18T18:33:11.336829Z", "iopub.status.busy": "2026-08-18T18:33:11.335989Z", "iopub.status.idle": "2026-08-18T18:33:11.342037Z", "shell.execute_reply": "2026-08-18T18:33:11.340863Z" }, "tags": [ "hide-in-docs" ] }, "outputs": [], "source": [ "# Check whether easydiffraction is installed; install it if needed.\n", "# Required for remote environments such as Google Colab.\n", "import importlib.util\n", "\n", "if importlib.util.find_spec('easydiffraction') is None:\n", " %pip install easydiffraction==0.20.1" ] }, { "cell_type": "markdown", "id": "1", "metadata": {}, "source": [ "# Na₂Ca₃Al₂F₁₄ — powder neutron TOF — Jorgensen-Von Dreele (Gaussian)\n", "\n", "Verifies the Jorgensen-Von Dreele pseudo-Voigt profile for the NCAF\n", "time-of-flight powder reference, with the Lorentzian terms (γ₀, γ₁,\n", "γ₂) forced to zero so it reduces to the Gaussian case.\n", "\n", "**Reference:** the FullProf scale and all other parameters are\n", "taken from the FullProf reference." ] }, { "cell_type": "code", "execution_count": 2, "id": "2", "metadata": { "execution": { "iopub.execute_input": "2026-08-18T18:33:11.344584Z", "iopub.status.busy": "2026-08-18T18:33:11.343756Z", "iopub.status.idle": "2026-08-18T18:33:15.438225Z", "shell.execute_reply": "2026-08-18T18:33:15.436797Z" } }, "outputs": [], "source": [ "import easydiffraction as edi\n", "from easydiffraction import ExperimentFactory\n", "from easydiffraction import StructureFactory\n", "from easydiffraction.analysis import verification as verify" ] }, { "cell_type": "markdown", "id": "3", "metadata": {}, "source": [ "## Build the project" ] }, { "cell_type": "code", "execution_count": 3, "id": "4", "metadata": { "execution": { "iopub.execute_input": "2026-08-18T18:33:15.440484Z", "iopub.status.busy": "2026-08-18T18:33:15.440128Z", "iopub.status.idle": "2026-08-18T18:33:15.945643Z", "shell.execute_reply": "2026-08-18T18:33:15.943730Z" } }, "outputs": [], "source": [ "project = edi.Project()" ] }, { "cell_type": "markdown", "id": "5", "metadata": {}, "source": [ "## Define the structure" ] }, { "cell_type": "code", "execution_count": 4, "id": "6", "metadata": { "execution": { "iopub.execute_input": "2026-08-18T18:33:15.947797Z", "iopub.status.busy": "2026-08-18T18:33:15.947540Z", "iopub.status.idle": "2026-08-18T18:33:15.962409Z", "shell.execute_reply": "2026-08-18T18:33:15.961571Z" } }, "outputs": [], "source": [ "structure = StructureFactory.from_scratch(name='ncaf')\n", "structure.space_group.name_h_m = 'I 21 3' # FullProf Space group symbol\n", "structure.cell.length_a = 10.250256 # FullProf a\n", "structure.atom_sites.create(\n", " id='Ca', # FullProf Atom\n", " type_symbol='Ca', # FullProf Typ\n", " fract_x=0.46610, # FullProf X\n", " fract_y=0.0, # FullProf Y\n", " fract_z=0.25, # FullProf Z\n", " adp_type='Biso', # FullProf Biso\n", " adp_iso=0.88721, # FullProf Biso\n", ")\n", "structure.atom_sites.create(\n", " id='Al', # FullProf Atom\n", " type_symbol='Al', # FullProf Typ\n", " fract_x=0.25163, # FullProf X\n", " fract_y=0.25163, # FullProf Y\n", " fract_z=0.25163, # FullProf Z\n", " adp_type='Biso', # FullProf Biso\n", " adp_iso=0.65230, # FullProf Biso\n", ")\n", "structure.atom_sites.create(\n", " id='Na', # FullProf Atom\n", " type_symbol='Na', # FullProf Typ\n", " fract_x=0.08472, # FullProf X\n", " fract_y=0.08472, # FullProf Y\n", " fract_z=0.08472, # FullProf Z\n", " adp_type='Biso', # FullProf Biso\n", " adp_iso=1.89168, # FullProf Biso\n", ")\n", "structure.atom_sites.create(\n", " id='F1', # FullProf Atom\n", " type_symbol='F', # FullProf Typ\n", " fract_x=0.13748, # FullProf X\n", " fract_y=0.30533, # FullProf Y\n", " fract_z=0.11947, # FullProf Z\n", " adp_type='Biso', # FullProf Biso\n", " adp_iso=0.89535, # FullProf Biso\n", ")\n", "structure.atom_sites.create(\n", " id='F2', # FullProf Atom\n", " type_symbol='F', # FullProf Typ\n", " fract_x=0.36263, # FullProf X\n", " fract_y=0.36333, # FullProf Y\n", " fract_z=0.18669, # FullProf Z\n", " adp_type='Biso', # FullProf Biso\n", " adp_iso=1.27175, # FullProf Biso\n", ")\n", "structure.atom_sites.create(\n", " id='F3', # FullProf Atom\n", " type_symbol='F', # FullProf Typ\n", " fract_x=0.46120, # FullProf X\n", " fract_y=0.46120, # FullProf Y\n", " fract_z=0.46120, # FullProf Z\n", " adp_type='Biso', # FullProf Biso\n", " adp_iso=0.78029, # FullProf Biso\n", ")\n", "\n", "project.structures.add(structure)" ] }, { "cell_type": "markdown", "id": "7", "metadata": {}, "source": [ "## Load the FullProf reference" ] }, { "cell_type": "code", "execution_count": 5, "id": "8", "metadata": { "execution": { "iopub.execute_input": "2026-08-18T18:33:15.964150Z", "iopub.status.busy": "2026-08-18T18:33:15.963951Z", "iopub.status.idle": "2026-08-18T18:33:15.978656Z", "shell.execute_reply": "2026-08-18T18:33:15.977864Z" } }, "outputs": [], "source": [ "FULLPROF_PROJECT_DIR = 'pd-neut-tof_ncaf_jorgensen-von-dreele'\n", "FULLPROF_PRF_FILE = 'tmpl_one_bank.prf'\n", "FULLPROF_SUM_FILE = 'tmpl_one_bank.sum'\n", "FULLPROF_BAC_FILE = 'tmpl_one_bank.bac'\n", "FULLPROF_LABEL = verify.fullprof_label(FULLPROF_PROJECT_DIR, FULLPROF_SUM_FILE)\n", "\n", "FULLPROF_ZERO = -13.88128 # FullProf Zero\n", "FULLPROF_SCALE = 36.17374 # FullProf Scale\n", "FULLPROF_TWOTHETA_BANK = 152.827 # FullProf 2ThetaBank\n", "FULLPROF_DTT1 = 20773.12305 # FullProf Dtt1\n", "FULLPROF_DTT2 = -1.08308 # FullProf Dtt2\n", "FULLPROF_SIGMA_0 = 0.0 # FullProf Sigma-0\n", "FULLPROF_SIGMA_1 = 0.0 # FullProf Sigma-1\n", "FULLPROF_SIGMA_2 = 15.6959 # FullProf Sigma-2\n", "FULLPROF_GAMMA_0 = 0.0 # FullProf Gamma-0\n", "FULLPROF_GAMMA_1 = 0.0 # FullProf Gamma-1\n", "FULLPROF_GAMMA_2 = 0.0 # FullProf Gamma-2\n", "FULLPROF_ALPHA_0 = -0.009276 # FullProf alph0\n", "FULLPROF_ALPHA_1 = 0.109622 # FullProf alph1\n", "FULLPROF_BETA_0 = 0.006705 # FullProf beta0\n", "FULLPROF_BETA_1 = 0.009708 # FullProf beta1\n", "FULLPROF_WDT = 40.0 # FullProf Wdt\n", "\n", "x, calc_fullprof = verify.load_fullprof_calc_profile(\n", " FULLPROF_PROJECT_DIR,\n", " FULLPROF_PRF_FILE,\n", " FULLPROF_BAC_FILE,\n", " FULLPROF_ZERO,\n", ")" ] }, { "cell_type": "markdown", "id": "9", "metadata": {}, "source": [ "## Create the experiment" ] }, { "cell_type": "code", "execution_count": 6, "id": "10", "metadata": { "execution": { "iopub.execute_input": "2026-08-18T18:33:15.981103Z", "iopub.status.busy": "2026-08-18T18:33:15.980693Z", "iopub.status.idle": "2026-08-18T18:33:16.778541Z", "shell.execute_reply": "2026-08-18T18:33:16.777767Z" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "⚠️ Switching peak profile type adds these settings with defaults: \n", " • broad_lorentz_gamma_0=0.0 \n", " • broad_lorentz_gamma_1=0.0 \n", " • broad_lorentz_gamma_2=0.0 \n", " • broad_lorentz_size=0.0 \n", " • broad_lorentz_strain=0.0 \n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "\u001b[1;36mPeak profile type for experiment \u001b[0m\u001b[32m'ncaf'\u001b[0m\u001b[1;36m changed to\u001b[0m\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "jorgensen-von-dreele\n" ] } ], "source": [ "experiment = ExperimentFactory.from_scratch(\n", " name='ncaf',\n", " sample_form='powder',\n", " beam_mode='time-of-flight',\n", " radiation_probe='neutron',\n", " scattering_type='bragg',\n", ")\n", "verify.set_reference_as_measured(experiment, x, calc_fullprof)\n", "\n", "experiment.linked_structures.create(structure_id='ncaf', scale=FULLPROF_SCALE)\n", "\n", "experiment.instrument.setup_twotheta_bank = FULLPROF_TWOTHETA_BANK\n", "experiment.instrument.calib_d_to_tof_offset = FULLPROF_ZERO\n", "experiment.instrument.calib_d_to_tof_linear = FULLPROF_DTT1\n", "experiment.instrument.calib_d_to_tof_quadratic = FULLPROF_DTT2\n", "\n", "experiment.peak.type = 'jorgensen-von-dreele'\n", "experiment.peak.broad_gauss_sigma_0 = FULLPROF_SIGMA_0\n", "experiment.peak.broad_gauss_sigma_1 = FULLPROF_SIGMA_1\n", "experiment.peak.broad_gauss_sigma_2 = FULLPROF_SIGMA_2\n", "experiment.peak.broad_lorentz_gamma_0 = FULLPROF_GAMMA_0\n", "experiment.peak.broad_lorentz_gamma_1 = FULLPROF_GAMMA_1\n", "experiment.peak.broad_lorentz_gamma_2 = FULLPROF_GAMMA_2\n", "experiment.peak.rise_alpha_0 = FULLPROF_ALPHA_0\n", "experiment.peak.rise_alpha_1 = FULLPROF_ALPHA_1\n", "experiment.peak.decay_beta_0 = FULLPROF_BETA_0\n", "experiment.peak.decay_beta_1 = FULLPROF_BETA_1\n", "\n", "experiment.excluded_regions.create(id='1', start=0, end=30000)\n", "experiment.excluded_regions.create(id='2', start=50000, end=200000)\n", "\n", "experiment.peak.cutoff_fwhm = FULLPROF_WDT\n", "\n", "project.experiments.add(experiment)" ] }, { "cell_type": "markdown", "id": "11", "metadata": {}, "source": [ "## edi-cryspy VS FullProf" ] }, { "cell_type": "code", "execution_count": 7, "id": "12", "metadata": { "execution": { "iopub.execute_input": "2026-08-18T18:33:16.780440Z", "iopub.status.busy": "2026-08-18T18:33:16.780250Z", "iopub.status.idle": "2026-08-18T18:33:17.262658Z", "shell.execute_reply": "2026-08-18T18:33:17.261836Z" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "\u001b[1;36mCalculator for experiment \u001b[0m\u001b[32m'ncaf'\u001b[0m\u001b[1;36m already set to\u001b[0m\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "cryspy\n" ] }, { "data": { "text/html": [ "
Loading plot…
" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" } ], "source": [ "experiment.calculator.type = 'cryspy'\n", "\n", "experiment.linked_structures['ncaf'].scale = FULLPROF_SCALE\n", "\n", "project.analysis.calculate()\n", "calc_ed_cryspy = experiment.data.intensity_calc\n", "LABEL_ED_CRYSPY = verify.engine_label('cryspy')\n", "\n", "project.display.pattern_comparison(\n", " 'ncaf',\n", " reference=calc_fullprof,\n", " candidate=calc_ed_cryspy,\n", " reference_label=FULLPROF_LABEL,\n", " candidate_label=LABEL_ED_CRYSPY,\n", ")" ] }, { "cell_type": "markdown", "id": "13", "metadata": {}, "source": [ "## Agreement check" ] }, { "cell_type": "code", "execution_count": 8, "id": "14", "metadata": { "execution": { "iopub.execute_input": "2026-08-18T18:33:17.264481Z", "iopub.status.busy": "2026-08-18T18:33:17.264264Z", "iopub.status.idle": "2026-08-18T18:33:17.271921Z", "shell.execute_reply": "2026-08-18T18:33:17.271152Z" } }, "outputs": [ { "data": { "text/html": [ "
ComparisonMetricExpectedActualOK
1edi 0.20.1 (cryspy 0.13.0) vs FullProf 8.40Profile diff (%)< 2.50.12✅
2Max deviation (%)< 60.12✅
3Area ratio0.99 to 1.011.0005✅
4Shape correlation> 0.9991.0000✅
" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" }, { "data": { "text/plain": [ "True" ] }, "execution_count": 8, "metadata": {}, "output_type": "execute_result" } ], "source": [ "# cryspy matches FullProf with the seeded FullProf scale, so it is\n", "# gated as a regression test.\n", "verify.assert_patterns_agree([\n", " (\n", " f'{LABEL_ED_CRYSPY} vs {FULLPROF_LABEL}',\n", " verify.restrict_to_included(experiment, calc_fullprof),\n", " calc_ed_cryspy,\n", " ),\n", "])" ] } ], "metadata": { "jupytext": { "cell_metadata_filter": "-all", "main_language": "python", "notebook_metadata_filter": "-all" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.14.6" } }, "nbformat": 4, "nbformat_minor": 5 }