{ "cells": [ { "cell_type": "code", "execution_count": 1, "id": "0", "metadata": { "execution": { "iopub.execute_input": "2026-06-30T22:27:16.556166Z", "iopub.status.busy": "2026-06-30T22:27:16.555988Z", "iopub.status.idle": "2026-06-30T22:27:16.559971Z", "shell.execute_reply": "2026-06-30T22:27:16.559262Z" }, "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.19.1" ] }, { "cell_type": "markdown", "id": "1", "metadata": {}, "source": [ "# Diamond — powder neutron TOF — DREAM (ESS, McStas)\n", "\n", "Verifies the Jorgensen back-to-back exponential TOF profile against a\n", "FullProf reference fitted to McStas-simulated reduced data from the\n", "DREAM diffractometer at ESS.\n", "\n", "**Refinement:** the overall scale only; all other parameters are\n", "taken from the FullProf reference." ] }, { "cell_type": "code", "execution_count": 2, "id": "2", "metadata": { "execution": { "iopub.execute_input": "2026-06-30T22:27:16.561684Z", "iopub.status.busy": "2026-06-30T22:27:16.561526Z", "iopub.status.idle": "2026-06-30T22:27:19.417127Z", "shell.execute_reply": "2026-06-30T22:27:19.416132Z" } }, "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-06-30T22:27:19.418955Z", "iopub.status.busy": "2026-06-30T22:27:19.418680Z", "iopub.status.idle": "2026-06-30T22:27:19.675643Z", "shell.execute_reply": "2026-06-30T22:27:19.674883Z" } }, "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-06-30T22:27:19.677866Z", "iopub.status.busy": "2026-06-30T22:27:19.677706Z", "iopub.status.idle": "2026-06-30T22:27:19.682758Z", "shell.execute_reply": "2026-06-30T22:27:19.681877Z" } }, "outputs": [], "source": [ "structure = StructureFactory.from_scratch(name='diamond')\n", "\n", "structure.space_group.name_h_m = 'F d -3 m' # FullProf Space group symbol\n", "structure.space_group.coord_system_code = '1' # FullProf \":1\" origin choice\n", "\n", "structure.cell.length_a = 3.567 # FullProf a\n", "\n", "structure.atom_sites.create(\n", " id='C', # FullProf Atom\n", " type_symbol='C', # FullProf Typ\n", " fract_x=0.125, # FullProf X\n", " fract_y=0.125, # FullProf Y\n", " fract_z=0.125, # FullProf Z\n", " adp_type='Biso', # FullProf Biso\n", " adp_iso=0.89263, # 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-06-30T22:27:19.684365Z", "iopub.status.busy": "2026-06-30T22:27:19.684220Z", "iopub.status.idle": "2026-06-30T22:27:19.690930Z", "shell.execute_reply": "2026-06-30T22:27:19.690107Z" } }, "outputs": [], "source": [ "FULLPROF_PROJECT_DIR = 'pd-neut-tof_diamond_dream'\n", "FULLPROF_PRF_FILE = 'diamond.prf'\n", "FULLPROF_SUM_FILE = 'diamond.sum'\n", "FULLPROF_BAC_FILE = 'diamond.bac'\n", "FULLPROF_LABEL = verify.fullprof_label(FULLPROF_PROJECT_DIR, FULLPROF_SUM_FILE)\n", "\n", "FULLPROF_ZERO = 0.0 # FullProf Zero\n", "FULLPROF_SCALE = 0.1011780 # FullProf Scale\n", "FULLPROF_TWOTHETA_BANK = 90.0 # FullProf 2ThetaBank\n", "FULLPROF_DTT1 = 28385.86133 # FullProf Dtt1\n", "FULLPROF_DTT2 = 0.0 # FullProf Dtt2\n", "FULLPROF_SIGMA_0 = 46937.7188 # FullProf Sigma-0\n", "FULLPROF_SIGMA_1 = 4887.9180 # FullProf Sigma-1\n", "FULLPROF_SIGMA_2 = 0.0 # FullProf Sigma-2\n", "FULLPROF_ALPHA_0 = 0.0 # FullProf alph0\n", "FULLPROF_ALPHA_1 = 0.022544 # FullProf alph1\n", "FULLPROF_BETA_0 = 0.014330 # FullProf beta0\n", "FULLPROF_BETA_1 = 0.0 # FullProf beta1\n", "FULLPROF_WDT = 30.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-06-30T22:27:19.692553Z", "iopub.status.busy": "2026-06-30T22:27:19.692408Z", "iopub.status.idle": "2026-06-30T22:27:19.956550Z", "shell.execute_reply": "2026-06-30T22:27:19.955684Z" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "\u001b[1;36mPeak profile type for experiment \u001b[0m\u001b[32m'diamond'\u001b[0m\u001b[1;36m changed to\u001b[0m\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "jorgensen\n" ] } ], "source": [ "experiment = ExperimentFactory.from_scratch(\n", " name='diamond',\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='diamond', 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'\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.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=10000)\n", "experiment.excluded_regions.create(id='2', start=70000, 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-06-30T22:27:19.958327Z", "iopub.status.busy": "2026-06-30T22:27:19.958067Z", "iopub.status.idle": "2026-06-30T22:27:20.646079Z", "shell.execute_reply": "2026-06-30T22:27:20.645234Z" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "\u001b[1;36mCalculator for experiment \u001b[0m\u001b[32m'diamond'\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['diamond'].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", " 'diamond',\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": [ "## Fit edi-cryspy to FullProf" ] }, { "cell_type": "code", "execution_count": 8, "id": "14", "metadata": { "execution": { "iopub.execute_input": "2026-06-30T22:27:20.648253Z", "iopub.status.busy": "2026-06-30T22:27:20.648060Z", "iopub.status.idle": "2026-06-30T22:27:21.560714Z", "shell.execute_reply": "2026-06-30T22:27:21.559840Z" } }, "outputs": [ { "data": { "text/html": [], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" }, { "data": { "application/javascript": [ "\n", "(function() {\n", " const button = document.getElementById('ed-fit-stop-6ca13998e46540b3bf72a65918ba6bf3-button');\n", " const status = document.getElementById('ed-fit-stop-6ca13998e46540b3bf72a65918ba6bf3-status');\n", " const kernelId = '';\n", " if (!button) {\n", " return;\n", " }\n", "\n", " function setStatus(text) {\n", " if (status) {\n", " status.textContent = text;\n", " }\n", " }\n", "\n", " function pageConfig() {\n", " const element = document.getElementById('jupyter-config-data');\n", " if (!element || !element.textContent) {\n", " return {};\n", " }\n", " try {\n", " return JSON.parse(element.textContent);\n", " } catch (error) {\n", " return {};\n", " }\n", " }\n", "\n", " function baseUrl(config) {\n", " const configured = config.baseUrl || config.base_url ||\n", " (window.Jupyter && Jupyter.notebook && Jupyter.notebook.base_url);\n", " if (configured) {\n", " return configured.endsWith('/') ? configured : configured + '/';\n", " }\n", " const markers = ['/lab/', '/notebooks/', '/tree/'];\n", " for (const marker of markers) {\n", " const index = window.location.pathname.indexOf(marker);\n", " if (index >= 0) {\n", " return window.location.pathname.slice(0, index + 1);\n", " }\n", " }\n", " return '/';\n", " }\n", "\n", " function token(config) {\n", " return config.token || new URLSearchParams(window.location.search).get('token') || '';\n", " }\n", "\n", " function cookie(name) {\n", " const prefix = name + '=';\n", " for (const part of document.cookie.split(';')) {\n", " const trimmed = part.trim();\n", " if (trimmed.startsWith(prefix)) {\n", " return decodeURIComponent(trimmed.slice(prefix.length));\n", " }\n", " }\n", " return '';\n", " }\n", "\n", " function notebookPath() {\n", " const decoded = decodeURIComponent(window.location.pathname);\n", " const markers = ['/lab/tree/', '/notebooks/', '/tree/'];\n", " for (const marker of markers) {\n", " const index = decoded.indexOf(marker);\n", " if (index >= 0) {\n", " return decoded.slice(index + marker.length);\n", " }\n", " }\n", " return '';\n", " }\n", "\n", " async function kernelFromSessions(config) {\n", " const url = new URL(baseUrl(config) + 'api/sessions', window.location.origin);\n", " const authToken = token(config);\n", " if (authToken) {\n", " url.searchParams.set('token', authToken);\n", " }\n", " const response = await fetch(url, {credentials: 'same-origin'});\n", " if (!response.ok) {\n", " return '';\n", " }\n", " const sessions = await response.json();\n", " const path = notebookPath();\n", " const session = sessions.find((item) => item.path === path) || sessions[0];\n", " return session && session.kernel ? session.kernel.id : '';\n", " }\n", "\n", " async function interruptKernel(config, resolvedKernelId) {\n", " const url = new URL(\n", " baseUrl(config) + 'api/kernels/' + resolvedKernelId + '/interrupt',\n", " window.location.origin\n", " );\n", " const authToken = token(config);\n", " if (authToken) {\n", " url.searchParams.set('token', authToken);\n", " }\n", " const xsrfToken = cookie('_xsrf');\n", " const headers = {};\n", " if (xsrfToken) {\n", " headers['X-XSRFToken'] = xsrfToken;\n", " }\n", " const response = await fetch(url, {\n", " method: 'POST',\n", " credentials: 'same-origin',\n", " headers: headers\n", " });\n", " return response.ok;\n", " }\n", "\n", " button.addEventListener('click', async function() {\n", " button.disabled = true;\n", " setStatus('Stopping...');\n", " const config = pageConfig();\n", " try {\n", " const resolvedKernelId = kernelId || await kernelFromSessions(config);\n", " if (!resolvedKernelId) {\n", " throw new Error('Could not resolve the current kernel id.');\n", " }\n", " const interrupted = await interruptKernel(config, resolvedKernelId);\n", " if (!interrupted) {\n", " throw new Error('Jupyter Server rejected the interrupt request.');\n", " }\n", " setStatus('Interrupt sent...');\n", " } catch (error) {\n", " button.disabled = false;\n", " setStatus('Use Kernel > Interrupt to stop this fit.');\n", " }\n", " });\n", "})();\n" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" }, { "name": "stdout", "output_type": "stream", "text": [ "\u001b[1;36mStandard fitting\u001b[0m\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "📋 Using experiment 🔬 \u001b[32m'diamond'\u001b[0m for \u001b[32m'single'\u001b[0m fitting\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "🚀 Starting fit process with \u001b[32m'lmfit \u001b[0m\u001b[32m(\u001b[0m\u001b[32mleastsq\u001b[0m\u001b[32m)\u001b[0m\u001b[32m'\u001b[0m\u001b[33m...\u001b[0m\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "📈 Goodness-of-fit progress:\n" ] }, { "data": { "text/html": [ "
iterationtime (s)χ²change / status
110.0526.61
250.240.00100.0% ↓
380.400.00
" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" }, { "name": "stdout", "output_type": "stream", "text": [ "🏆 Best goodness-of-fit \u001b[1m(\u001b[0mreduced χ²\u001b[1m)\u001b[0m is \u001b[1;36m0.00\u001b[0m at iteration \u001b[1;36m5\u001b[0m\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "✅ Fitting complete.\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "⚙️ Settings used:\n" ] }, { "data": { "text/html": [ "
NameValueDescription
1max_iterations1000Maximum solver iterations.
" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" }, { "name": "stdout", "output_type": "stream", "text": [ "📋 Least-squares fit results:\n" ] }, { "data": { "text/html": [ "
MetricValue
1🧪 Minimizerlmfit (leastsq)
2✅ Overall statussuccess
3⏱️ Fitting time (seconds)0.40
4🔁 Iterations5
5📏 Goodness-of-fit (reduced χ²)0.00
6📏 R-factor (Rf, %)0.40
7📏 R-factor squared (Rf², %)0.20
8📏 Weighted R-factor (wR, %)0.20
" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" }, { "name": "stdout", "output_type": "stream", "text": [ "📈 Refined parameters:\n" ] }, { "data": { "text/html": [ "
datablockcategoryentryparameterunitsstartvalues.u.change
1diamondlinked_structurediamondscale0.101210.30900.000510088.97 % ↑
" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" }, { "data": { "text/html": [ "
• start = parameter value before refinement
• value = refined value from least-squares minimization
• s.u. = standard uncertainty (one sigma), from the covariance matrix
• change = relative change from start, in %; ↑ = increase, ↓ = decrease
" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" }, { "data": { "text/html": [ "
Loading plot…
" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" } ], "source": [ "experiment.linked_structures['diamond'].scale.free = True\n", "\n", "project.analysis.fit()\n", "project.display.fit.results()\n", "\n", "project.analysis.calculate()\n", "calc_ed_cryspy_refined = experiment.data.intensity_calc\n", "LABEL_ED_CRYSPY_REFINED = verify.engine_label('cryspy', note='refined')\n", "\n", "project.display.pattern_comparison(\n", " 'diamond',\n", " reference=calc_fullprof,\n", " candidate=calc_ed_cryspy_refined,\n", " reference_label=FULLPROF_LABEL,\n", " candidate_label=LABEL_ED_CRYSPY_REFINED,\n", ")" ] }, { "cell_type": "markdown", "id": "15", "metadata": {}, "source": [ "## Agreement check" ] }, { "cell_type": "code", "execution_count": 9, "id": "16", "metadata": { "execution": { "iopub.execute_input": "2026-06-30T22:27:21.562819Z", "iopub.status.busy": "2026-06-30T22:27:21.562656Z", "iopub.status.idle": "2026-06-30T22:27:21.570413Z", "shell.execute_reply": "2026-06-30T22:27:21.569492Z" } }, "outputs": [ { "data": { "text/html": [ "
ComparisonMetricExpectedActualOK
1edi 0.19.1 (cryspy 0.12.1, refined) vs FullProf 8.40Profile diff (%)< 2.50.20✅
2Max deviation (%)< 60.23✅
3Area ratio0.99 to 1.010.9990✅
4Shape correlation> 0.9991.0000✅
" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" }, { "data": { "text/plain": [ "True" ] }, "execution_count": 9, "metadata": {}, "output_type": "execute_result" } ], "source": [ "verify.assert_patterns_agree(\n", " [\n", " (\n", " f'{LABEL_ED_CRYSPY_REFINED} vs {FULLPROF_LABEL}',\n", " verify.restrict_to_included(experiment, calc_fullprof),\n", " calc_ed_cryspy_refined,\n", " ),\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.5" } }, "nbformat": 4, "nbformat_minor": 5 }