forked from nextgen-astrodata/DAL1
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
200 lines (141 loc) · 6.5 KB
/
README
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
CONTENTS:
1. Introduction
2. Getting the source code
3. Organization of the source code
4. External dependencies
5. Configuration, build and installation
6. Further reading
_________________________________________________________________________________
>>> 1. Introduction
The size and complexity of astronomical data are growing at relentless rates.
This increase is especially apparent in the radio community as evidenced by the
data challenges faced by many of the SKA pathfinders and other major radio
telescopes such as LOFAR, EVLA, ALMA, ASKAP, MeerKAT, MWA, LWA and eMERLIN.
Enormous data rates are also becoming a challenge for large optical projects
that are currently ramping up including Pan-Starrs and LSST. As progress towards
meeting these challenges, ASTRON and the LOFAR project are currently exploring
the use of the Hierarchical Data Format, version 5 (HDF5) for LOFAR radio data
encapsulation.
The Data Access Library (DAL) is a library that abstracts the underlying file
format from the user when working with radio astronomy data. Underlying formats
may include HDF5, AIPS++/CASA tables, FITS or specific raw formats. This library
is available to both the C/C++ developer and the Python user via the "pydal"
module.
_________________________________________________________________________________
>>> 2. Getting the source code
As of Feb 15, 2001 the DAL can be cloned directly from the master repository
hosted on Github (http://github.com):
git clone https://github.com/nextgen-astrodata/DAL.git DAL
Once your checkout from the Git repository is complete, follow the
instructions as described in the section "Configuration and build" below.
_________________________________________________________________________________
>>> 3. Organization of the source code
The components of the DAL is organized into the following directory structure:
DAL
|-- build
|-- cmake
|-- data .. Reference data sets used for rest programs.
|-- doc .. Documentation.
| `-- figures
`-- src
|-- apps .. Application programs build on top of the library.
| `-- bf2h5
|-- dal
| |-- core .. Core library classes
| | `-- test
| |-- coordinates .. Representation of world coordinates
| | `-- test
| |-- data_common .. Common functionality for datasets
| | `-- test
| `-- data_hl .. High-level interfaces to datasets
| `-- test
|-- pydal .. Bindings to the Python scripting language
| `-- test
`-- test
|-- hdf5
|-- python
`-- swig
_________________________________________________________________________________
>>> 4. External dependencies
To build the DAL from the sources you need a number of installed software
packages and utilities:
* CMake, >=2.6 (www.cmake.org)
* Doxygen, >=1.6 (http://www.stack.nl/~dimitri/doxygen)
* HDF5 library, >=1.8.3 (www.hdfgroup.org/HDF5)
* WCSLIB, >=4.2 (www.atnf.csiro.au/people/mcalabre/WCS)
* CFITSIO, >=3.0 (heasarc.gsfc.nasa.gov/fitsio)
* CASACORE (code.google.com/p/casacore)
* Boost C++ Libraries, >=1.40.0 (www.boost.org)
* Python, >= 2.6 (www.python.org)
_________________________________________________________________________________
>>> 5. Configuration, build and installation
The DAL uses the CMake (www.cmake.org) Cross-Platform Makefile Generator for
configuration and control of the build.
Once your checkout from the Git repository is complete you will have a directory
structure on disk as described in section "Organization of the source code"
above.
cd DAL
mkdir build
cd build
cmake ..
make
The default installation location is "/opt/dal"; if you want to change this,
you can tell CMake so by using
cmake -D DAL_INSTALL_PREFIX=<installation prefix> ..
The CMake scripts will check a number of standard locations for the required
3-party packages (such as Boost, HDF5, etc.), but if you are using a custom
version installed at a non-standard location, you might need to aid CMake in
finding all required components:
cmake -DHDF5_ROOT_DIR=<basedir of HDF5 install> ..
In to install the DAL you will have to run
make install
from within the build directory. Depending on whether you are installing into a
local directory or into a system-directory, appropriate permissions might be
required.
In order to maintain compatibility with the Filesystem Hierarchy Standard (FHS)
the following default installation layout has been defined:
/opt
└── dal CMAKE_INSTALL_PREFIX = DAL_INSTALL_PREFIX
├── bin DAL_INSTALL_BINDIR = DAL_INSTALL_PREFIX/bin
├── include DAL_INSTALL_INCLUDEDIR = DAL_INSTALL_PREFIX/include
│ ├── coordinates
│ ├── core
│ ├── data_common
│ └── data_hl
├── lib DAL_INSTALL_LIBDIR = DAL_INSTALL_PREFIX/lib
└── share
└── doc
└── html
However the installation configuration can be tailored depending on your personal
needs:
1. Default settings.
If no further command line parameter are provided, the installation will be
done according to the above described structure.
2. Custom installation prefix.
In order to install into an existing standard directory structure -- such
such as e.g. "/usr/local" -- use
-D DAL_INSTALL_PREFIX=<prefix>
3. Installation as part of the LUS.
In order to simplify installation of the DAL as part of the LOFAR User
Software distribution, a preset has been defined which can be used through
-D LUS_INSTALL_PREFIX=<prefix>
where <prefix>=$LOFARSOFT/release
For further details and additional configuration options, consult the Doxygen-based
documentation.
_________________________________________________________________________________
>>> 6. Further reading
Further detailed information regarding
- configuration options
- installation options
- organization of the code base
- library modules
can be found in the HTML documentation generated using Doxygen:
cd build
cmake ..
make Documentation
If you are having trouble with unresolved package dependencies, you can configure
for generation of documentation only:
cmake -DDOCUMENTATION_ONLY=YES ..
make
Point your web-browser to
build/doc/html/index.html