From 543f8bfb477003665840909871e7ed0d85300288 Mon Sep 17 00:00:00 2001 From: Jon Wright Date: Thu, 13 Apr 2017 16:47:06 +0200 Subject: [PATCH] link docs to github page --- README.TXT | 1 + docs/sphx/index.rst | 20 ++++++++++++++------ 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/README.TXT b/README.TXT index 28254611..017f8c69 100644 --- a/README.TXT +++ b/README.TXT @@ -5,6 +5,7 @@ wright@esrf.fr This is the source code for ImageD11. Probably you wanted a compiled version. +Some documentation is here: https://pythonhosted.org/ImageD11/ To use it, try this: diff --git a/docs/sphx/index.rst b/docs/sphx/index.rst index 442cc478..9349097c 100644 --- a/docs/sphx/index.rst +++ b/docs/sphx/index.rst @@ -6,13 +6,19 @@ Welcome to ImageD11's documentation! ==================================== -ImageD11 is for identifying individual grains in spotty area detector diffraction images. +Beware: you might find some of this information is out of date or wrong. +Please fix anything you find that is wrong and send a pull request. +This documentation lives in the docs/sphx part of the sources. + +ImageD11 is for identifying individual grains in spotty area detector +diffraction images. It finds the spots and helps you to try to index them. -After you index the spots you can then work on extracting useful information on a grain -by grain basis. -ImageD11 is intended to be complementary to the rest of the FABLE software. ImageD11 has -a strong focus on fast preliminary data analysis which can be carried -out during experiments in order to make decisions about the experimental setup etc. +After you index the spots you can then work on extracting useful information +on a grain by grain basis. +ImageD11 is intended to be complementary to the rest of the FABLE software. +ImageD11 has a strong focus on fast preliminary data analysis which can be +carried out during experiments in order to make decisions about the +experimental setup etc. The package includes facilities for peak searching in two dimensional area detector images using a simple threshold. @@ -45,6 +51,8 @@ Contents: fileformats batchprocessing +Here is a pdf file with a worked example for making a centre of +mass grain map :download:`com_guide.pdf<../com_guide.pdf>` Indices and tables ==================