aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2014-04-04 11:26:21 +0200
committerThomas White <taw@physics.org>2014-04-07 16:41:43 +0200
commitb4dc27e6212ef444e51536898be6b5825166e16b (patch)
tree99fd9f7f8cded0c434e576628d59df08c6fa58b3 /README
parente619466c35a54ee630abc9520c7246266dbee1e5 (diff)
Update docs
Diffstat (limited to 'README')
-rw-r--r--README43
1 files changed, 6 insertions, 37 deletions
diff --git a/README b/README
index fb33745f..92fe7857 100644
--- a/README
+++ b/README
@@ -49,8 +49,6 @@ characteristics of such data which call for a specialised software suite are:
CrystFEL includes programs for simulating and processing patterns subject to the
above characteristics. The main programs are:
- - pattern_sim, for simulating patterns.
-
- indexamajig, a "batch indexer" and data reduction program.
It is used for finding hits, locating peaks, indexing
patterns and constructing lists of h,k,l,I,sigma(I) (or
@@ -59,6 +57,10 @@ above characteristics. The main programs are:
- process_hkl, for merging per-pattern lists of intensities into a
single reflection list.
+ - cell_explorer, for examining distributions of lattice parameters.
+
+ - ambigator, a tool for resolving indexing ambiguities,
+
- partialator, for merging patterns more accurately (and much more
slowly) using post refinement.
@@ -71,10 +73,9 @@ In addition, there is also:
- check_hkl, for determining things like completeness.
- - partial_sim, for calculating partial reflection intensities.
-
+ - pattern_sim, for simulating patterns.
-Included at no extra cost are:
+ - partial_sim, for calculating partial reflection intensities.
- hdfsee, a simple viewer for images stored in HDF5 format.
@@ -151,35 +152,3 @@ If you are installing from Git, the following extra things apply:
- You will not be able to use the "--enable-gtk-doc" option to configure unless
you have at least version 1.9 of gtk-doc installed.
-
-Program name
-------------
-
-There seems to be a tendency to capitalise all the letters in the names of
-programs in scientific publications. Sometimes the authors do this, other times
-the journal capitalises them at the proof stage. It's as if they think it
-somehow makes the name look more "computery", or perhaps "trademark-y".
-
-Well, it's not 1970 any more, and programs are no longer input on punched cards.
-That means we can have capitalisation any way we choose.
-
-The name for the overall software suite is "CrystFEL", with this being the only
-acceptable capitalisation. The individual programs should always be referred to
-with all letters in lower case, exactly the same as the names of the binaries.
-Put the names in quotes or italics if this sounds strange to you. The only
-exception is if the name of the program comes at the start of a sentence, or in
-a title, or similar position where a word would normally be capitalised.
-
-In most cases, it will be more appropriate to refer to the overall suite than to
-one of its constituent programs.
-
-The following are NOT acceptable forms: "CRYSTFEL", "crystFEL", "Crystfel",
-"INDEXAMAJIG" and "PATTERN_SIM". If you use any of these (particularly the
-first one and the last two), the Capitalisation Monster will hunt you down and
-eat you.
-
-In addition, CrystFEL is made up of "programs", not "routines" nor "procedures".
-(The "programs" in turn are made up from "routines" and "procedures", but unless
-you are exploring the source code, there's no need for you to know about that).
-
-I hope you can forgive the fussiness.