Unverified Commit 327ca959 authored by Gigg, Martyn Anthony's avatar Gigg, Martyn Anthony Committed by GitHub
Browse files

Merge pull request #30461 from mantidproject/19498_crystalfield_docs

Crystal field theory docs
parents 95aeea76 7666df16
This diff is collapsed.
......@@ -10,6 +10,9 @@ The python facilities for Crystal Field calculations are available in Mantid fro
The module provides two main classes: `CrystalField` defines various properties of a crystal field and
`CrystalFieldFit` manages the fitting process.
Theoretical background can be found in the :ref:`concept page <Crystal Field Theory>`
and worked examples in the :ref:`examples page <Crystal_Field_Examples>`.
Setting up crystal field parameters
-----------------------------------
......
.. Crystal Field:
.. _Crystal_Field_Examples:
=============
Crystal Field
=============
======================
Crystal Field Examples
======================
Mantid supports the calculation and fitting of inelastic neutron scattering (INS) measurements of transitions between crystal field (or crystalline electric field) energy levels. The scientific background is summarised in the :ref:`concept page <Crystal structure and reflections>` whilst the syntax of the Python commands used is described in the :ref:`interface page <Crystal Field Python Interface>`
Mantid supports the calculation and fitting of inelastic neutron scattering (INS) measurements of transitions between crystal field (or crystalline electric field) energy levels. The scientific background is summarised in the :ref:`concept page <Crystal Field Theory>` whilst the syntax of the Python commands used is described in the :ref:`interface page <Crystal Field Python Interface>`
This page contains specific worked examples. The data files can be found `here <https://github.com/mducle/cf_examples/raw/master/cf_examples_data.zip>`_. Please download and unzip this into a folder which is on your Mantid path (set using the "Manage User Directories" menu item).
......@@ -269,3 +269,5 @@ Tying Background Parameters
# Ties some of the parameters in the Gaussian to different values.
cf.background.functions[1].ties(PeakCentre=9.0, Height=2.0)
.. categories:: Techniques
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment