Debian Codegraph @

doc/index.rst

raw
1 ======
2 DXfile
3 ======
4
5 Scientific Data Exchange :cite:`DeCarlo:14b` is a set of guidelines for storing
6 scientific data and metadata in a Hierarchical Data Format 5 :cite:`HDF:01` file.
7
8 HDF5 :cite:`HDF:01` has many important characteristics for scientific data
9 storage. It offers platform-independent binary data storage with optional
10 compression, hierarchical data ordering, and support for MPI-based
11 parallel computing. Data are stored with alphanumeric tags, so that one
12 can examine a HDF5 file’s contents with no knowledge of how the file
13 writing program was coded. Tools for this examination include the
14 HDF5-supplied command-line utility :cite:`HDF:02` to examine the contents
15 of any HDF5 file, or the freely-available Java program :cite:`HDF:03`
16 to interactively examine the file.
17
18 At synchrotron facilities using the EPICS :cite:`EPICS:01` software for area
19 detectors :cite:`AD:01` with the NDFileHDF5 plugin :cite:`AD:02`, is possible
20 to save Data Exchange files by properly configure the detector and the HDF
21 schema attribute files .
22
23 This reference guide describes the basic design principles of Data
24 Exchange, examples of their application, a core reference for guidelines
25 common to most uses, and coding examples.
26
27
28 Features
29 --------
30 * The definition of the scientific data exchange.
31 * A python interface for writing scientific data exchange files.
32 * XML attribute files for writers with the EPICS Area Detector HDF plug-in.
33
34 Highlights
35 ----------
36 * Based on Hierarchical Data Format 5 (HDF5).
37 * Focuses on technique rather than instrument descriptions.
38 * Provenance tracking for understanding analysis steps and results.
39 * Ease of readability.
40
41 Contribute
42 ----------
43
44 * Documentation: https://github.com/data-exchange/dxfile/tree/master/doc
45 * Issue Tracker: https://github.com/data-exchange/dxfile/issues
46 * Source Code: https://github.com/data-exchange/dxfile
47
48 Contents
49 --------
50
51 .. toctree::
52 :maxdepth: 1
53
54 source/introduction
55 source/reference
56 source/xraytomo
57 source/install
58 source/api
59 source/demo
60 source/credits
61 source/appendix
62
63
64 Indices and tables
65 ==================
66
67 * :ref:`genindex`
68 * :ref:`modindex`
69 * :ref:`search`