Skip to content

Commit

Permalink
link docs to github page
Browse files Browse the repository at this point in the history
  • Loading branch information
jonwright committed Apr 13, 2017
1 parent a6b7c1f commit 543f8bf
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
1 change: 1 addition & 0 deletions README.TXT
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ [email protected]

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:

Expand Down
20 changes: 14 additions & 6 deletions docs/sphx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
==================
Expand Down

0 comments on commit 543f8bf

Please sign in to comment.