aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2015-02-12 17:25:32 +0100
committerThomas White <taw@physics.org>2015-02-12 18:08:34 +0100
commitab23cf7550ca8253d55ee5bb6c5836502c439fe0 (patch)
tree90fcba4c7cf8d6f8c4124f96d728b846bd952f29
parentafc554d3a541adb10e8bd534fd1fc430811abe57 (diff)
Update README
-rw-r--r--README26
1 files changed, 19 insertions, 7 deletions
diff --git a/README b/README
index 10f22783..0f8f420f 100644
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
CrystFEL - Crystallography with a FEL
-------------------------------------
-Copyright © 2012-2014 Deutsches Elektronen-Synchrotron DESY,
+Copyright © 2012-2015 Deutsches Elektronen-Synchrotron DESY,
a research centre of the Helmholtz Association.
Authors:
@@ -18,16 +18,25 @@ Authors:
Anton Barty <anton.barty@desy.de>
Cornelius Gati <cornelius.gati@desy.de>
Fedor Chervinskii <fedor.chervinskii@gmail.com>
- Alexandra Tolstikova
+ Alexandra Tolstikova <alexandra.tolstikova@desy.de>
Wolfgang Brehm <wolfgang.brehm@gmail.com>
Valerio Mariani <valerio.mariani@desy.de>
Parker de Waal <Parker.deWaal@vai.org>
Takanori Nakane <nakane.t@gmail.com>
Keitaro Yamashita <k.yamashita@spring8.or.jp>
+CrystFEL is free software: you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+CrystFEL is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+CrystFEL. If not, see <http://www.gnu.org/licenses/>.
-Please read the AUTHORS file for a full list of contributions and contributors.
-See the COPYING file for licence conditions. Summary: GPLv3+.
Thank you for reading the documentation. :-)
@@ -55,9 +64,6 @@ CrystFEL includes programs for simulating and processing patterns subject to the
above characteristics. The main programs are:
- 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
- similar) for each pattern.
- process_hkl, for merging per-pattern lists of intensities into a
single reflection list.
@@ -66,6 +72,10 @@ above characteristics. The main programs are:
- ambigator, a tool for resolving indexing ambiguities,
+ - geoptimiser, for refining detector geometry.
+
+ - whirligig, for finding multiple shots from single crystals.
+
- partialator, for merging patterns more accurately (and much more
slowly) using post refinement.
@@ -86,6 +96,8 @@ In addition, there is also:
- render_hkl, for turning reflection lists into pretty graphics.
+ - list_events, for creating event lists from multi-event files
+
There is also a folder full of scripts for achieving many related tasks.
CrystFEL mostly works with images stored in HDF5 format, unit cell data in PDB