aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: fd387fa9a766f144be4e763f6eccc7f4d79b9dbd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
CrystFEL - Data processing for serial crystallography
=====================================================

Copyright © 2012-2021 Deutsches Elektronen-Synchrotron DESY,
                      a research centre of the Helmholtz Association.

See AUTHORS as well as individual source code files for full details of contributors.

Introduction
------------

CrystFEL is a suite of programs for processing (and simulating) Bragg
diffraction data from "serial crystallography" experiments, often (but not
always) performed using an X-ray Free-Electron Laser.  Compared to rotation data,
some of the particular characteristics of such data which call for a
specialised software suite are:

* The sliced, rather than integrated, measurement of intensity data.  Many, if
  not all reflections are partially integrated.

* Many patterns (thousands) are required - high throughput is needed.

* The crystal orientations in each pattern are random and uncorrelated.

* Merging into lower symmetry point groups may require the resolution of
  indexing ambiguities.


Getting started
---------------

See INSTALL.md for installation instructions.

The best way to get started, after installation, is to run command ```crystfel```
to start the graphical user interface.


Licence
-------

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/>.


Funding acknowledgements
------------------------

Development of CrystFEL is primarily funded by the Helmholtz Association.

Partial funding for CrystFEL has previously been provided by:

- "X-Probe", a project of the European Union's 2020 Research and Innovation
  Program Under the Marie Skłodowska-Curie grant agreement 637295 (2015-2018).

- The BMBF German-Russian Cooperation "SyncFELMed", grant 05K14CHA (2014-2017).

- BioStruct-X, a project funded by the Seventh Framework Programme (FP7) of the
  European Commission (2011-2016).