-
Notifications
You must be signed in to change notification settings - Fork 0
/
INSTALL.txt
133 lines (82 loc) · 3.87 KB
/
INSTALL.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
Section of Biomedical Image Analysis
Department of Radiology
University of Pennsylvania
3600 Market Street, Suite 380
Philadelphia, PA 19104
Web: http://www.rad.upenn.edu/sbia/
Email: sbia-software at uphs.upenn.edu
Copyright (c) 2012 University of Pennsylvania. All rights reserved.
See http://www.rad.upenn.edu/sbia/software/license.html or COPYING file.
INTRODUCTION
============
This document contains the build and installation instructions.
For general build and installation instructions which apply to any software
developed on top of the SBIA Build system And Software Implementation
Standard (BASIS) [1], please refer to the respective how-to guide of the
BASIS documentation [2].
OBTAINING A COPY OF THE SOFTWARE
================================
Please see the corresponding section of the BASIS how-to guide [2].
INSTALLING A BINARY DISTRIBUTION PACKAGE
========================================
Please see the corresponding section of the BASIS how-to guide [2].
RUNTIME REQUIREMENTS
====================
This software has no runtime dependencies.
BUILDING THE SOFTWARE FROM SOURCES
==================================
Build Dependencies
------------------
The following software has to be installed (if not optional).
- BASIS >= 2.0
Web Site: http://www.rad.upenn.edu/sbia/software/basis/
Download: http://www.rad.upenn.edu/sbia/software/distributions/basis-current-source.tar.gz
This project is based on BASIS, a meta-project developed at SBIA to
standardize and simplify the software development.
Build Steps
-----------
The common steps to build, test, and install software based on CMake,
including this software, are as follows:
1. Extract source files.
2. Create build directory and change to it.
3. Run CMake to configure the build tree.
4. Build the software using selected build tool.
5. Test the built software.
6. Install the built files.
On Unix-like systems with GNU Make as build tool, these build steps can be
summarized by the following sequence of commands executed in a shell,
where $package and $version are shell variables which represent the name
of this package and the obtained version of the software.
$ tar xzf $package-$version-source.tar.gz
$ mkdir $package-$version-build
$ cd $package-$version-build
$ ccmake -DBASIS_DIR:PATH=/path/to/basis ../$package-$version-source
- Press 'c' to configure the build system and 'e' to ignore warnings.
- Set CMAKE_INSTALL_PREFIX and other CMake variables and options.
- Continue pressing 'c' until the option 'g' is available.
- Then press 'g' to generate the configuration files for GNU Make.
$ make
$ make test (optional)
$ make install (optional)
An exhaustive list of minimum build dependencies, including the build tools
along detailed step-by-step build, test, and installation instructions can
be found in the corresponding "Building the Software from Sources" section
of the BASIS how-to guide on software installation [2].
Please refer to this guide first if you are uncertain about above steps or
have problems to build, test, or install the software on your system.
If this guide does not help you resolve the issue, please contact us at
<sbia-software at uphs.upenn.edu>. In case of failing tests, please attach
the output of the following command to your email:
$ ctest -V >& test.log
In the following, only package-specific CMake settings available to
configure the build and installation of this software are documented.
CMake Options
-------------
(no additional CMake options considered by this package)
Advanced CMake Options
----------------------
(no additional advanced CMake options considered by this package)
REFERENCES
==========
[1] http://www.rad.upenn.edu/sbia/software/basis/
[2] http://www.rad.upenn.edu/sbia/software/basis/howto/install/