From 77b77b6663f0cd256a589f5ac9b29bb5292d52f3 Mon Sep 17 00:00:00 2001 From: Marcraven Date: Tue, 3 Jul 2018 15:01:07 +0200 Subject: [PATCH] Update README.md --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d47d8d..2cfb2bc 100644 --- a/README.md +++ b/README.md @@ -1 +1,7 @@ -# 3D-Laue-Multi-Grain-Indexing \ No newline at end of file +# 3D-Laue-Multi-Grain-Indexing + +This functions and scripts are used for multi-grain indexing of oligo-crystals from neutron Laue data. +The two main scripts are Seeding_Single_Grain_Fitting and Global_Fitting, as described in the paper. +The Maps script is used for segmentation of diffraction peaks, the variables "Peaks" and "Blobs" generated serve as input for the setup_experimental_data function in the single and global fitting scripts. +A list of valid reflecting planes and structure factors has to be provided to the "setup_grains" function so that the crystallographic information is correct. The format read by the parser function "importh" is the output format of the Mantid crystallography suite. +setup_beamline, setup_experimental_data, setup_grains and setup_detectors have to be configured based on the parameters of every specific experiment and sample.