forked from ratt-ru/meqtrees-timba
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README_build.txt
156 lines (116 loc) · 6.84 KB
/
README_build.txt
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
MeqTrees and the CMAKE Build System
===================================
CMake is a platform independent build system, that allows
out of source code builds.
Full cmake documentation can be found at:
www.cmake.org
Convenience Configuration Script
================================
A script has been provided in the Tools/Build directory for convenience for the most common
use cases. The function of the script is to create build product locations
and configure cmake appropriately.
e.g. To create a debug build
> Tools/Build/bootstrap_cmake debug
> cd build/debug
> make
e.g. To create an optimised build
> Tools/Build/bootstrap_cmake release
> cd build/release
> make
Run the script without arguments to get a synopsis of usage. You may supply various cmake arguments (see below) and they will be passed through.
Setting up paths to run the build directly
==========================================
Developers usually prefer to run MeqTrees directly from the source/build tree. To do this, proceed as follows:
1. Your build directory needs to be called Timba/build/BUILDNAME. The convenience scripts above use the standard BUILDNAMEs 'debug' and 'release'.
2. There has to be a tree of symlinks called Timba/install/symlinked-BUILDNAME. These symlinks point to libraries, etc. in your build tree. If your BUILDNAME is one of the standard, i.e. 'debug' or 'release', the appropriate symlink tree is already provided.
3. If using a nonstandard BUILDNAME, you can make your own symlink tree as follows:
$ cd Timba/install
$ ./make_symlink_tree.sh BUILDNAME
4. Purr has to be available on your system. Either check out Purr into your home directory, or make sure that the outer Purr directory (the one containing Purr and Kittens) is in your PYTHONPATH.
5. Finally, add this to your .bashrc:
$ source ~/Timba/install/timba-init.sh
$ timba-setup release # or 'debug', or whatever your BUILDNAME is
This will setup all paths to point to the named build. Note that you can reinvoke the timba-setup command manually in your shell, should you wish to switch to a different build.
You should be able to start meqtrees by running 'meqbrowser.py'.
Simple Install
==============
Note that the CMAKE_INSTALL_PREFIX variable will define the relative location
where the install target will put files. On unix platforms this defaults to "/usr/local".
Step 1:
create a directory for the build to take place
> mkdir meqtrees_build; cd meqtrees_build
Step 2:
from this build directory run cmake to create the platform specific make files
> cmake PATH_TO_SRC
Step 3:
run the platform specific make command.
e.g. unix based systems
> make install
e.g. windows based systems (MSVC)
> nmake install
External Dependencies
=====================
CMake attempts to find all the external dependencies in the project automatically.
If you have these pacakges installed in an unusual place you may have to specify the locations
through cmake variables. The variable is dependent on the package - for the names, look in the
relevant Find<packageName>.cmake files found in the cmake directory of the src code and the
system cmake module directory (usually /usr/share/cmake/Modules).
e.g. cmake -DBLITZ_LIB_DIR=/opt/mpp/blitz/0.9/lib PATH_TO_SRC
The list of external dependency packages are specified by the dependencies variable set
in the top level CMakeList.txt file.
Alternative Builds
==================
Various alternative builds are available. Activate them by setting the
appropriate Cmake variable:
Variable Description
---------------------------------------------------
USE_MPI | Use the mpi parrallelisation library
e.g. -DUSE_MPI=TRUE
Setting CMake Variables
=======================
Various options and configurations are available by setting CMake variables
CMake variables can be set by calling cmake with the -D option
e.g.
cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_CXX_COMPILER=g++-4.2 <SRC_DIRECTORY>
Build options
--------------
Variable | Function
------------------------------------------------------------
CMAKE_BUILD_TYPE=DEBUG|RELEASE | build debug or release versions
|
CMAKE_CXX_FLAGS= | Extra flags to use when compiling C++ source files.
|
LIBRARY_INSTALL_DIR= | specify location for meqtrees libraries
| ( default: CMAKE_INSTALL_PREFIX/lib )
|
MEQTREES_INSTALL_DIR= | specify location for meqtrees libraries and other resources
| ( default: LIBRARY_INSTALL_DIR/meqtrees )
|
ICON_INSTALL_DIR= | directory to install icons (default: MEQTREES_INSTALL_DIR/icons )
|
PYTHON_INSTALL_DIR= | installation dir for meqtrees specific python scripts
| (default: MEQTREES_INSTALL_DIR/Timba )
cmake specifc variables can be found here: http://www.cmake.org/Wiki/CMake_Useful_Variables
-------------------------------------- For Developers -----------------------------------------------------------------
MEQTREES Specific MACROS
========================
A number of convenience Macros are provided to ease the creation of MeqTrees packages.
Here is a quick overview of the main functionality, refer to the cmake/meqmacros.cmake
for full information.
The MEQPACKAGE
--------------
Specify the contents are a MeqPackage and the primary dependencies on other MeqTrees Packages
This will ensure all the INCLUDE_PATHS are correct and the MEQPACKAGE_LIBRARIES variable
will contain all the required variables. It will also genertate the correct lofar_config.h file.
e.g. CMakeLists.txt for a simple MEQPACKAGE
# Exported Paths for External Dependencies
INCLUDE_DIRECTORIES(${AnExternalPackage_INCLUDE_DIR})
INCLUDE_DIRECTORIES(${AnotherExternalPackage_INCLUDE_DIR}) # These INCLUDE paths will be exported to dependent Meq Packages
MEQPACKAGE(MyPackageName meqPackageDependenyA meqPackageDependencyB) # declares the MeqPacake "MyPackageName" and its primary dependencies
# Non-Exported Paths should be specified after the MEQPACKAGE macro
INCLUDE_DIRECTORIES(${ADependencyNotExported_INCLUDE_DIR}) # This INCLUDE directory will not be exported - local to this package only
# Export Header files myHeader.h and myHeader2.h to the MyPackage directory
INCLUDE_SETUP(MyPackage myHeader.h myHeader2.h)
# mark libraries for export to other MeqPackages
# with the MEQPACKAGE_ADD_LIBRARIES macro
MEQPACKAGE_ADD_LIBRARIES(myPackageLib ${AnExternalPackage_LIB_DIR} ${AnotherExternalPackage_LIB_DIR})