Project

General

Profile

Preparing a Windows machine for Bilder » History » Version 107

John Cary, 05/22/2018 08:46 AM

1 1 Redmine Admin
# Preparing a Windows machine for Bilder (64-bit only)
2
3 39 Ted Sume
For building on Windows 10 in Ubuntu, follow the Linux Bilder setup instructions. 
4
5 22 Matt Copper
Windows 7/2008: For 64-bit systems, 64-bit applications are stored in C:\Program Files and 32-bit applications are stored in C:\Program Files (x86). UserAccountControlSettings can be fine-tuned (see Control-Panel, System and Security, Action Center). Set Control Setting to the lowest setting (never notify) to avoid unwanted dialog boxes. This requires a reboot to take effect! At least for ATLAS, the UAC Settings must be adjusted to "never notify" (this action is generally recommended while taking all the steps below). 
6 1 Redmine Admin
7
# Basic Windows Configuration
8
9
_Warning:_ In following the directions below, pre-defined env variables like CL, PETSC_DIR, PETSC_ARCH, and others will cause problems.  For example, one user had CL=/nologo which prevented the version and other info from being printed and caused bilder to fail.
10
11
# Editing your system path on Windows
12
13
From the Start menu, right click on My Computer and choose Properties. Choose the Advanced Tab, and click the Environment Variables button towards the bottom of the dialog. In System Variables, highlight Path and click Edit. This is where you make changes to your system path.
14
15 89 David Alexander
# If your machine is on a Windows Domain (as compared to a WORKGROUP), then ensure that Windows knows its domainname
16 1 Redmine Admin
17 96 David Alexander
If your machine is on a Windows Domain, then Bilder can set a common variable that makes sense in that Domain. If you are not on a Windows Domain, then Bilder will still work fine (except for maybe emailing). To ensure Windows knows its domainname to the following.
18 89 David Alexander
19 1 Redmine Admin
* From a command prompt, type the command: 
20
21
~~~~~~
22
ipconfig /all
23
~~~~~~
24
25 96 David Alexander
Look for the value of the "Primary Dns Suffix" field, which should be your domain name (i.e. txcorp.com).
26 1 Redmine Admin
27
* If cygwin is already installed,
28
29
~~~~~~
30
ipconfig /all | grep -i "Primary Dns Suffix" | sed -e 's/^.*: //'
31
~~~~~~
32
33 89 David Alexander
should return the domainname. 
34 1 Redmine Admin
35
* For Windows 7/Windows 2008 machines that are not a member of the Windows Domain, Active Directory, do the following:
36
    1. Right click on My Computer, select properties
37
    2. Click on Advanced system settings
38
    3. Select the computer name tab
39
    4. Click the change button
40
    5. Click the more button
41
    6. Enter the Primary DNS suffix. i.e. txcorp.com 
42
43
# Create initial directories
44
45
* Create the folder C:\\bin (if not already present).
46
* Add or move C:\\bin to the front of your system path.
47
48 74 David Alexander
# What is "Required" for Bilder
49 1 Redmine Admin
50 74 David Alexander
What is absolutely required for Bilder depends on what you are trying to build. For example, if you are **only building user documentation**, then you only need
51 37 John Cary
52 74 David Alexander
* Blat (for emailing yourself)
53 36 John Cary
* Cygwin (for bash shell)
54 1 Redmine Admin
* CMake from an installer
55 38 John Cary
* Python from an installer
56
* Latex (MikTek below)
57 1 Redmine Admin
* Visual Studio Express (for nmake)
58 36 John Cary
59 1 Redmine Admin
and then you can add the arguments,  -W python,cmake, and your installed Python and CMake will be used if your path is correct.
60
61 82 John Cary
If you are building through Qt5,
62
63
* 2017-15.4.5 (the particular revision for building QtWebEngine).  If not building Qt5, but using it, then at least need VS2015 or VS2017.
64
* Windows 10 or Windows 10 SDK
65
66 83 John Cary
Unfortunately, VS2015 and later have a different way have handling certain functions, as discussed at https://stackoverflow.com/questions/30412951/unresolved-external-symbol-imp-fprintf-and-imp-iob-func-sdl2, and so one has to build many packages, such as OpenSSL.
67
68
69 74 David Alexander
Below is a list of the Tools and Libraries that are most often needed.
70
71
# Tools (Required for most common builds within Bilder)
72
73 1 Redmine Admin
## Blat
74
75 74 David Alexander
*Blat is a sendmail client for Windows needed to send emails.*
76 1 Redmine Admin
77
* Download Blat from [The Blat SourceForge](http://sourceforge.net/projects/blat) Site and extract all files. As of 07/18/2013, this is version 311.
78
* Extract the blat311 folder into C:\\bin.
79
* Copy the C:\bin\blat311\full\blat.{exe,dll} to C:\bin\blat.{exe,dll}
80
* Execute the following command in a cygwin terminal
81
82
~~~~~~
83
    blat -install mail.txcorp.com <username>@txcorp.com
84
~~~~~~
85
86
## CMake
87
88 74 David Alexander
*CMake is a cross-platform build system needed to configure many of necessary packages.*
89 1 Redmine Admin
90
* Install [CMake (a 32-bit application)](http://www.cmake.org/files/).
91 80 David Alexander
  * Version 3.1 or higher is required.  Picking a later version is better because it will allow bilder to build future versions of cmake.
92 26 John Cary
  * Add the CMake path to the front of the system path! (Needed to build newer 64 bit versions through Bilder)
93 1 Redmine Admin
  * When this step is complete, make sure the newest CMake is the only one in your system path.
94
95 10 Redmine Admin
## CYGWIN
96 1 Redmine Admin
97 74 David Alexander
*Cygwin is a Unix shell program for Windows and is needed to run the bash code of Bilder.*
98
99 1 Redmine Admin
### Gotchas (in advance)
100
101
* Do not install Cygwin's MinGW. Those are installed in a separate area to reduce conflicts.
102
* Do not install Cygwin's rc, or you may get a weird error (/focmTryCompileExec.exe.embed.manifest.res: No such file or directory) about cl being invalid.  This can be seen by the output of 'which rc'.
103
* Do not install Cygwin's mt.  If 'which mt' returns /bin/mt or /usr/bin/mt, then move this aside too.
104 11 Redmine Admin
* If 'which link' returns /usr/bin/link, then move this aside (mv /usr/bin/link.exe /usr/bin/linkoff.exe) so that it is not picked up to replace the Visual Studio link.  (This is where we could define BILDER_LINK.)
105 1 Redmine Admin
* Make sure that 'which find' returns the cygwin version (/usr/bin/find), not the Windows version.
106
* Make sure 'which cmd' returns the Windows version. If not, check that your bash_profile has not made an error in setting your path.
107
* If you get an error like "ValueError: Symbol table not found" when building numpy, you are somehow using a 32-bit version of objdump.  Disable the 32-bit version.
108
109
### Updating Cygwin
110
111
* Be sure to select the version of subversion that is compatible with any other sister machines being run through jenkins.  They must all use the same version of svn, which must be the same version chosen in Jenkins.
112
* If you have moved aside any of the interfering commands (e.g. link, mt, rc) in the past and have recently updated cygwin or Windows, then do the 'which' checks again.
113
* Recreate the /etc/passwd and /etc/group file again using the mkpasswd and mkgroup commands described in the Configuring Cygwin section.
114
* Install Cygwin from [here](http://cygwin.com/install.html). There are now separate installers for 64 bit (setup-x86_64.exe ) and 32 bit (setup-x86.exe).
115
* Upon running setup-*.exe, select the packages:
116 3 Redmine Admin
  * Base -> util-linux
117
  * Devel -> bison
118
  * Devel -> flex
119 4 Redmine Admin
  * Devel -> gcc-g++ and gcc-fortran (4.9.3 does not compile sqlite, so choose 4.9.2)
120 3 Redmine Admin
  * Devel -> git
121
  * Devel -> make
122
  * Devel -> mercurial
123 1 Redmine Admin
  * Devel -> patch
124 27 John Cary
  * Devel -> subversion (If this machine will be a Jenkins slave, the version of subversion that is consistent with the Jenkins master's svnkit should be chosen. The latest version supported by svnkit is 1.8.14 at the time, Dec. 31, 2016, of this writing.)
125 3 Redmine Admin
  * Editors -> vim and emacs (and alternate editors of choice)
126
  * Math -> bc
127
  * Net -> openssh
128 25 Matt Copper
  * Net -> curl
129 3 Redmine Admin
  * Python -> python (see note below)
130
  * Shells -> mintty
131
  * Utils -> diffutils
132
  * Utils -> dos2unix
133
  * Web -> wget
134 1 Redmine Admin
135
* Do NOT install any of the mingw packages.  If used, they must be installed separately to overcome path issues.  (NumPy will not accept the different, distinguishing name for mingw's gcc).
136
137
* Note: PATH should be set such that the Windows python is found before the cygwin python. We need the cygwin python to build PETSc. Once PETSc is cmaked, this requirement will go away.
138
* Note: mkshortcut.exe in cygutils 1.4.10-2 is broken, but as of (July 18, 2013 with cygutils version 1.4.12 this is fixed).  If the version of mkshortcut.exe that is installed when you run setup.exe doesn't work (i.e. mkshortcut -h segfaults), then go bach to cygwin setup and update your cygutils.
139
140
### Setting Cygwin Disk Mounts
141
142
* Create the directory winsame at the top level of both the Cygwin and Windows file systems. You must always work in this directory.  This is critical for getting the ATLAS linear algebra libraries to build. Do this via:
143
144
~~~~~~
145
mkdir /cygdrive/c/winsame
146
mkdir /winsame
147
mount C:/winsame /winsame
148
~~~~~~
149
150
To make this permanent, put
151
152
~~~~~~
153
C:/winsame /winsame ntfs binary 0 0
154
~~~~~~
155
156
as one line in /etc/fstab.
157
158
On Windows-64, additionally put
159
160
~~~~~~
161
C:/Program\040Files\040(x86) /ProgramFilesX86 ntfs binary 0 0
162
~~~~~~
163
164
as one line in /etc/fstab.  This allows one to construct a valid path with no parentheses as needed for ATLAS.
165
166
### Configuring Cygwin
167
168 6 Redmine Admin
* Use a "Cygwin64 Terminal" from basic cygwin installation above to perform all subsequent bash tasks
169 1 Redmine Admin
170
* If bilderizing a domain machine, create an /etc/passwd file with the following command
171
172
~~~~~~
173
mkpasswd -l -d -p /winsame > /etc/passwd
174
~~~~~~
175
176 71 Tech-X Corporation
* Add a single domain user to an already created /etc/password:
177
178
~~~~~~
179
mkpasswd -l -d -u {username} -p /winsame >> /etc/passwd
180
~~~~~~
181
182 1 Redmine Admin
* If bilderizing a non-domain machine, create an /etc/passwd file with the following command
183
184
~~~~~~
185
mkpasswd -l -p /winsame > /etc/passwd
186
~~~~~~
187
188
* If bilderizing a domain machine, create an /etc/group file with the following command
189
190
~~~~~~
191
mkgroup -l -d > /etc/group
192
~~~~~~
193
194
* If bilderizing a non-domain machine, create an /etc/group file with the following command
195
196
~~~~~~
197
mkgroup -l > /etc/group
198
~~~~~~
199
200
* Close the terminal and open a new one. You should see that the 'pwd' command shows that you are in a new home area directory: /winsame/<username>. Copy bash profile files from /home to /winsame and delete the previous home area for each user with the commands:
201
202
~~~~~~
203
cp /home/<username>/.* /winsame/<username>/
204
rm -rf /home/<username>
205
~~~~~~
206 52 John Cary
207 1 Redmine Admin
## Dependency Walker
208 52 John Cary
209 74 David Alexander
*Dependency Walker shows the DLL's that an executable depends on and is needed to find and copy-in DLLs to a final distribution.*
210 52 John Cary
211 1 Redmine Admin
__Make sure you download and install the correct version of dependencywalker for your machine (x86 for x86 machines, x64 for 64bit machines, etc).__
212 5 Redmine Admin
213 52 John Cary
Install [Dependency Walker](http://www.dependencywalker.com/) into C:\\bin.
214 1 Redmine Admin
215
## JOM
216
217 74 David Alexander
*JOM is an nmake wrapper needed to give  the -j flag capability of Unix make for faster compilation.*
218 1 Redmine Admin
219
* Create the folder C:\bin (if not already present).
220
* Add C:\bin to your system path (if not already there).
221
* Download jom.zip from [the Qt Project](https://wiki.qt.io/Jom).
222
* Extract the contents of jom.zip
223
* Move/copy jom.exe to C:\bin (you then can delete the remainder of the contents or keep for historical reasons).
224
225
## LaTeX
226
227 74 David Alexander
*LaTeX is a typesetting tool needed for building PDF files for user documentation.*
228 1 Redmine Admin
229 91 David Alexander
* Install [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html).  Choose "Letter" for paper size and "Yes" for "Install missing packages on-the-fly".
230 92 John Cary
* Install Basic MikTeX from [MikTeX](http://miktex.org/). Use the MikTeX Package Manager to install the packages noted at
231
[[LaTeX packages needed by Bilder]]
232 1 Redmine Admin
* Install [ghostscript](http://sourceforge.net/projects/ghostscript/files/GPL%20Ghostscript/9.04/).
233
234
235
## MPI
236
237 74 David Alexander
*MPI is a message passing interface for parallel code that is needed for some computation engines.*
238
239 98 Ted Sume
Download Microsoft MPI v8.1.1 from:
240 1 Redmine Admin
241 98 Ted Sume
https://www.microsoft.com/en-us/download/details.aspx?id=55991
242 1 Redmine Admin
243 93 John Cary
The binaries (e.g., mpiexec) are obtained by installing msmpisetup.exe.
244 1 Redmine Admin
245 94 John Cary
The libraries (msmpi.lib) are obtained by installing msmpisdk.msi.
246 1 Redmine Admin
247 93 John Cary
The installers will put mpiexec in your path and define the environment variables,
248
249
MSMPI_INC
250
MSMPI_BIN
251
MSMPI_LIB32
252
MSMPI_LIB64
253
254
which are used by CMake, e.g., to find the needed components of MSMPI.
255 1 Redmine Admin
256 85 John Cary
## Perl (required to build OpenSSL, therefore CMake)
257 1 Redmine Admin
258 74 David Alexander
*Perl is a programming language needed by some packages such as Qt*
259 1 Redmine Admin
260
* Download and install [ActiveState Perl](http://www.activestate.com/activeperl/downloads).
261
262
## Python
263
264 74 David Alexander
*Python is a programming language needed by many packages. Namely, any Python module needs Python to be installed.*
265
266 14 Redmine Admin
* As of VS12, bilder builds Python from a checkout of a git repo and no longer needs to be installed by hand. No PATH changes are needed either.
267 1 Redmine Admin
268 107 John Cary
## RCEDIT
269
270
* RCEDIT is a program that allows one to change the icon of an executable after its creation.  It can be obtained from https://github.com/electron/rcedit/releases, and it should be installed in C:\bin.
271
272 85 John Cary
## Ruby (required to build Qt5)
273
274
* Ruby, http://rubyinstaller.org/, must be installed first.
275
276 1 Redmine Admin
## Subversion
277
278 74 David Alexander
* Subversion is a revision control tool needed by bilder, for example, to know when packages are out of date.*
279 1 Redmine Admin
280 84 John Cary
* Install TortoiseSVN with its command line tools.
281 1 Redmine Admin
282 89 David Alexander
* With this, you will have two versions of svn on your machine. One is in `/usr/bin` under cygwin, and it is used for direct invocation at the bash command-line. The other is in `\Program Files`, and it is needed for getting repo versions when Bilder is invoked through Jenkins.  As of this writing, 1.9 is recommended (1.8 will also work, but lower versions will not).
283 33 Tech-X Corporation
284 1 Redmine Admin
~~~~~~
285
$ where svn
286 84 John Cary
C:\cygwin64\bin\svn.exe
287
C:\PROGRAM FILES\TORTOISESVN\bin\svn.exe
288
$ /usr/bin/svn --version | head -1
289
svn, version 1.9.7 (r1800392)
290
$ /cygdrive/c/Program\ Files/TortoiseSVN/bin/svn --version | head -n 1
291
svn, version 1.9.7 (r1800392)
292 15 Redmine Admin
~~~~~~
293 1 Redmine Admin
294
## Visual Studio
295 15 Redmine Admin
296 74 David Alexander
*Visual Studio contains the Microsoft command-line compiler (cl) used by packages with C/C++ code.* 
297
298 1 Redmine Admin
* Bilder works with VS12 (Visual Studio 2013). Since code is moving to C++11 standards, VS12 is required. We recommend you remove older versions of VS such as VS10 and VS9.
299
300
    * VS12: Visual Studio 2013 Community Edition from Microsoft [VS12 Download Site](https://www.visualstudio.com/en-US/products/visual-studio-community-vs)
301
302
* Install the latest update for Visual Studio. Open Visual Studio application. Going to Help -> About Microsoft Visual Studio, should show you the update version installed. As of July 2015 it is as Update 5. To update go to [Visual Studio Update Download](http://www.microsoft.com/en-us/download/details.aspx?id=48129).
303
304
* Ensure that Visual Studio is not in the system path. (Bilder adds this as needed.)
305 7 Redmine Admin
306 26 John Cary
### Compatibility with Python
307 7 Redmine Admin
308 1 Redmine Admin
* Python is built by Bilder.
309
310 78 Ted Sume
### Compatibility with CUDA 9.1 
311
* CUDA version 9.1 requires the use of Microsoft Visual Studio 2017 v15.4.5. See [VS2017 Prior Release Download Site](https://www.visualstudio.com/en-us/productinfo/installing-an-earlier-release-of-vs2017) for instructions on downloading a specific Release.
312 74 David Alexander
313 1 Redmine Admin
# Libraries (Required for most builds with Bilder)
314
315
## OpenSSL
316
317 85 John Cary
*OpenSSL is a security library needed by Python to build the SSL module, by cmake, libssh, and by Qt.*
318
*We no longer install OpenSSL on Windows, as Bilder builds it to be consistent with the compiler in use."
319 1 Redmine Admin
320 85 John Cary
### Legacy instructions.
321
322 1 Redmine Admin
* Download from http://slproweb.com/products/Win32OpenSSL.html
323 75 John Cary
* Choose the Win64 OpenSSL v1.0.2n  (not Light) on 64bit or the Win32 OpenSSL v1.0.2n on 32bit windows.
324 76 John Cary
* **The 1.1 series DOES NOT WORK with either libssh or Qt.**
325 1 Redmine Admin
* You may have to install Visual C++ Redistributables if the installer complains.
326
* During the installation, select "Copy OpenSSL DLLs to: The OpenSSL binaries (/bin) directory"
327
* After the installation on 64bit windows, goto C:\Windows\System32 and prepend libssl32.dll, libeay32.dll, and ssleay32.dll with an "OFF", if these files exist.  This and the next step are required so that dependency walker finds the SSL libs from the OpenSSL distro instead of the ones in C:\Windows\System32.
328
* Add C:\OpenSSL-Win64 (in some cases, we have seen that C:\OpenSSL-Win64\bin should be added instead) or the directory where you installed OpenSSL to the beginning of the system path. In particular, it needs to be in front of the CollabNet path and the Intel client path, because both contain libeay32.dll. A which for the libeay32.dll should give this installed version. For example:
329
330 30 John Cary
~~~~~~
331
which libeay32.dll
332 1 Redmine Admin
/cygdrive/c/OpenSSL-Win64/bin/libeay32.dll
333 73 Tech-X Corporation
~~~~~~
334 30 John Cary
335 1 Redmine Admin
* If built software has unexplained crashes, recheck the above command results.
336
337 74 David Alexander
## Qt
338 1 Redmine Admin
339 74 David Alexander
*Qt is a cross-platform GUI library needed to build packages that have Qt-based user interfaces.*
340
341 99 John Cary
Either Qt4 or Qt5 (or both) can be added.
342 74 David Alexander
343
###  [Building and Installing Qt4](#qt4)
344
345 41 John Cary
* Make sure no other Qt is in your system path.
346 42 John Cary
* Get the Qt Libraries from http://download.qt.io/official_releases/qt/4.8/4.8.7/. Download qt-opensource-windows-x86-vs2010-4.8.7.exe. (The vs2010 in the name is irrelevant as we will build Qt using the source code in this download.)
347 41 John Cary
* Run this program, selecting C:\winsame\builds-vsXX\winqt\<version> as your installation directory, where XX is the version of your Visual Studio.
348
* If 4.8.7, patch Qt by opening a Cygwin window:
349 1 Redmine Admin
350
~~~~~~
351
cd /winsame/builds-vs12/winqt/4.8.7
352 100 John Cary
~~~~~~
353
354 106 John Cary
To build with VS2017, you may need to patch.  For this you will need python with the patch module installed, which you can obtain by running composerall, e.g., with target, python.  Then do
355 100 John Cary
356
~~~~~~
357 102 John Cary
python -m patch /path/to/bilder/patches/02-fix_build_with_msvc2015-45e8f4ee.diff
358 1 Redmine Admin
~~~~~~
359
360 74 David Alexander
#### Compiling Qt4
361 1 Redmine Admin
362
* The copy/paste-able commands below assume VS12.
363
364
In a Visual Studio x64 DOS window:
365
366
~~~~~~
367 106 John Cary
set VER=12
368
REM could be 2017
369 104 John Cary
set SUBDIR=qt4
370 106 John Cary
REM or whatever is desired, e.g., qar\qt4 for jenkins
371 1 Redmine Admin
set SFX=vs%VER%
372
set QTVER=4.8.7
373
set CONTRIB_DIR=C:\winsame\%SUBDIR%\contrib-%SFX%
374
~~~~~~
375
376 103 John Cary
Modify the last line as needed, e.g., different drive or subdir.
377 1 Redmine Admin
378 106 John Cary
Set the platform args according to your compiler.
379 1 Redmine Admin
380 106 John Cary
For VS2013 (VS12).
381
382 101 John Cary
~~~~~~
383 106 John Cary
set PLATFORM_ARGS=-platform win32-msvc2013
384 101 John Cary
~~~~~~
385
386 106 John Cary
For VS2015 or VS2017:
387 101 John Cary
388
~~~~~~
389 106 John Cary
set PLATFORM_ARGS=-platform win32-msvc2015
390 101 John Cary
~~~~~~
391 1 Redmine Admin
392 64 John Cary
Then
393 1 Redmine Admin
394
~~~~~~
395
cd C:\winsame\builds-%SFX%\winqt\%QTVER%
396
configure.exe -prefix %CONTRIB_DIR%\qt-%QTVER%-sersh -debug-and-release -opensource -confirm-license -fast -no-sql-db2 -no-sql-ibase -no-sql-mysql -no-sql-oci -no-sql-odbc -no-sql-psql -no-sql-sqlite -no-sql-sqlite2 -no-sql-tds -no-libtiff -webkit -declarative %PLATFORM_ARGS%
397
~~~~~~
398
399 2 Redmine Admin
In a bash window launched from the previous DOS window (try `C:\cygwin64\bin\mintty -`, note that the dash is important!), execute the following (changing vsver to your version)
400 1 Redmine Admin
401
~~~~~~
402 106 John Cary
export VER=12 # or 2017
403 1 Redmine Admin
export SFX=vs${VER}
404
cd /winsame/builds-${SFX}/winqt/4.8.7
405 106 John Cary
SUBDIR=qt4 # Or whatever desired, e.g., qar/qt4
406 99 John Cary
export CONTRIB_DIR=/winsame/$SUBDIR/contrib-${SFX}
407
mkdir -p ${CONTRIB_DIR}/qt-4.8.7-sersh
408 1 Redmine Admin
cp -R mkspecs ${CONTRIB_DIR}/qt-4.8.7-sersh
409
cd ${CONTRIB_DIR}
410
ln -s qt-4.8.7-sersh qt-sersh
411
mkshortcut.exe -n qt-sersh.lnk qt-4.8.7-sersh
412
~~~~~~
413
414
Back in the Visual Studio x64 DOS window
415 99 John Cary
416 1 Redmine Admin
~~~~~~
417
cd C:\winsame\builds-%SFX%\winqt\4.8.7 
418 26 John Cary
set PATH=%PATH%;C:\winsame\builds-%SFX%\winqt\4.8.7\bin
419 106 John Cary
nmake
420
REM Took 3.5 hours on a 2.3 GHz Core2 Duo with Solid State Drive
421
nmake install
422
REM Took 10 minutes on a 2.3 GHZ Core2 Duo with Solid State Drive
423 1 Redmine Admin
~~~~~~
424
425
* If you want to use this qt outside of Bilder, add C:\winsame\contrib-%SFX%\qt-4.8.7-sersh\bin to the system path variable.  This may not work if you have more than one Bilder run.
426
427
In the bash window, then execute
428 42 John Cary
429 81 David Alexander
~~~~~~
430 106 John Cary
env QT_BLDRVERSION=4.8.7 /path/to//bilder/setinstald.sh -i $CONTRIB_DIR qt,sersh
431 81 David Alexander
~~~~~~
432 1 Redmine Admin
433
434
### Installing Qt5
435
436 97 David Alexander
These instructions are how to install the pre-built version of Qt 5 (version 5.10.0 ).  You can skip creating the Qt account.
437 81 David Alexander
438 97 David Alexander
* Get Qt-5.10.0 from http://download.qt.io/official_releases/qt/5.10/5.10.0/qt-opensource-windows-x86-5.10.0.exe
439
* Run this program, selecting `C:\winsame\builds-vs2017\winqt\5.10.0` as your installation directory. (Bilder will find Qt5 if it is here)
440 81 David Alexander
* Select the following components:
441 85 John Cary
** "MSVC 2017 64-bit,"
442
** "Qt WebEngine"
443
** "Sources"
444 42 John Cary
** (optionally) under Tools select "Qt Creator 4.5.0 CDB Debugger Support" and "Qt 3D Studio 1.0.0"
445 44 John Cary
446 1 Redmine Admin
447 85 John Cary
### [Building Qt5](#qt5)
448 79 John Cary
449 85 John Cary
*We are not building Qt5 at this time, but some legacy instructions are below.*
450 42 John Cary
451 85 John Cary
452 42 John Cary
#### Compiling Qt5
453 68 John Cary
454 85 John Cary
* Make sure no other Qt is in your system path.
455 42 John Cary
* The copy/paste-able commands below assume VS2017.
456 1 Redmine Admin
457
In a Visual Studio x64 DOS window:
458 68 John Cary
459 42 John Cary
~~~~~~
460 79 John Cary
set VER=2017
461 68 John Cary
set SFX=vs%VER%
462 70 John Cary
set QTVER=5.10.0
463 55 John Cary
set CONTRIB_DIR=C:\winsame\contrib-%SFX%
464 56 John Cary
set CONTRIB_DIR
465 70 John Cary
~~~~~~
466 56 John Cary
467 55 John Cary
Examine the output of the last command to make sure you have the supra-installation directory correct.
468 68 John Cary
469 69 John Cary
~~~~~~
470 1 Redmine Admin
cd C:\winsame\builds-%SFX%\winqt\%QTVER%\%QTVER%\Src
471
configure.bat -prefix %CONTRIB_DIR%\qt-%QTVER%-sersh -opensource -confirm-license -release -shared -opengl desktop -no-separate-debug-info -developer-build -make-tool jom -make libs -make tools -no-sql-db2 -no-sql-ibase -no-sql-mysql -no-sql-oci -no-sql-odbc -no-sql-psql -no-sql-sqlite -no-sql-sqlite2 -no-sql-tds -no-libjpeg -no-qml-debug -no-dbus -no-incredibuild-xge -no-directwrite -nomake examples -nomake tests -skip qtandroidextras -skip qtdoc -skip qtlocation -skip qtscript -skip qtserialbus -skip qtserialport -skip qtsensors -skip qtwayland -skip qtspeech
472
jom         # Took 45 minutes on a 4-core i7
473
jom install # Took 8 minutes on a 4-core i7
474 70 John Cary
~~~~~~
475 1 Redmine Admin
476 79 John Cary
Check that your installation contains Qt5WebEngine.
477 70 John Cary
478 1 Redmine Admin
Check whether the following changes are needed.
479 60 John Cary
480 1 Redmine Admin
~~~~~~
481
$ diff QtGui QtGui.orig
482
55c55
483
< // #include "qopenglextrafunctions.h"
484
---
485
> #include "qopenglextrafunctions.h"
486 60 John Cary
$ diff qopengl.h qopengl.h.orig
487
108c108
488
< // #  include <QtGui/qopengles2ext.h>
489
---
490
> #  include <QtGui/qopengles2ext.h>
491
~~~~~~
492
493
The VisIt team also uses the following.
494
495
~~~~~~
496 58 David Howdle
-mp -ltcg
497 62 John Cary
~~~~~~
498 1 Redmine Admin
499 85 John Cary
#### Completing installation
500 61 John Cary
501
In a bash window:
502 58 David Howdle
503 1 Redmine Admin
~~~~~~
504 79 John Cary
export VER=2017
505 1 Redmine Admin
export SFX=vs${VER}
506
export QTVER=5.10.0
507
export CONTRIB_DIR=/winsame/contrib-%SFX%
508
echo $CONTRIB_DIR
509 70 John Cary
~~~~~~
510 1 Redmine Admin
511 70 John Cary
Check that `CONTRIB_DIR` has the same value as before in the cmd shell, up to OS differences.  Then
512 79 John Cary
513 70 John Cary
~~~~~~
514
env QT_BLDRVERSION=5.10.1 /path/to/bilder/setinstald.sh -i $CONTRIB_DIR qt,sersh
515
cd $CONTRIB_DIR
516
ln -s qt-$QTVER-sersh qt-sersh
517
mkshortcut -n qt-sersh.lnk qt-$QTVER-sersh
518 74 David Alexander
~~~~~~
519 70 John Cary
520 74 David Alexander
# Addition Useful Tools
521
522
## Notepad++
523
524
* (Optional) Notepad++ is a free source code editor that is a great tool for Windows.
525
* Download from http://notepad-plus-plus.org/
526 1 Redmine Admin
* Install and pin to your taskbar.
527
528
# Experimental Tools and Libraries
529
530
These tools have not been fully vetted or built, so you need not do these.
531
532
## MinGW
533
534
See [[Installing MinGW]].
535
536
## ATLAS
537
538
See [[Installing ATLAS on Windows]].
539 8 Redmine Admin
540 1 Redmine Admin
# Cygwin and Paths
541 8 Redmine Admin
542 1 Redmine Admin
(This section assumes the user is familiar with the relations between Cygwin and Windows paths.)
543
544
The path is critical for when there are conflicting executables.  This is the case for Subversion and OpenSSL.
545
546
The cygwin and Windows versions of svn are incompatible due to line endings, so care must be taken as to which is used at what time.
547
548
The path to cygwin's version of svn will be ahead of the Windows Subversion so as to allow users to checkout a project using /usr/bin/svn and never worry about the Windows version of svn.
549
550
The path to the installed OpenSSL needs to be in front of the path to Subversion because during the copying in of OpenSSL libraries depends needs to find the ones in the OpenSSL installation not the Subversion installation.
551
552
## Usage under Jenkins
553
554
Jenkins uses `svnkit`, which is compatible with the Windows version of Subversion of the same version number.  So for jenkins usage, one must have the same version of `svn` installed across all slaves, and when `Bilder` runs under Jenkins, it must be sure to use the Windows version of `svn`.  There are two methods for doing this.  First, `bilder/jenkins/jenkinsbild` defines the environment variables, `BILDER_SVN`, `BILDER_SVNDIR`, and `BLDR_SVNVERSION`, which hold the correct executables to be used by `Bilder`.  However, in the configuration of some packages, notably VisIT in `visit.sh`, the path is used to find `svn`, and this gives the wrong executable.  For these cases, the path is modified just before configuration.
555
556
557
## Summary
558
559
* Bilder moves `/usr/bin` to just after the Python path and therefore to before
560
  `/cygdrive/c/Windows/system32`.
561
* Put the Windows Subversion path behind the Python path (and so behind `/usr/bin`).
562
    - `/usr/bin` must be removed from the path when configuring some packages in order to get the correct subversion when building under Jenkins.
563
564
# Bilder machine files for cygwin
565
566
The Bilder machine file for cygwin and Visual Studio 2013 (VS12) is bilder/machines/cygwin.vs12. It is sourced by bilder using the -m option. It augments PATH and sets the values of the INCLUDE, LIB, and LIBPATH variables.
567
568
In case of problems, one should check that the values of these were set correctly. This is done by starting up the **Visual Studio Command Prompt**, then starting rxvt as noted above. The values for or additions to these variables should agree with how they are being set or modified by the cygwin machine files.
569
570
# Setup for making Installers
571
572
## Visual Studios Redistributables
573
574
Download vcredist_x64.exe (Visual C++ Redistributable Packages for Visual Studio 2013)
575
576
http://www.microsoft.com/en-gb/download/details.aspx?id=40784
577
578
Choose only vcredist_x64.exe executable from list. Put executable in C:\bin.
579
580
## Sign Tools
581
582
* The Microsoft Signtool comes with Visual Studio, however, one must install a code-signing certificate. This process is site-specific so please see your system administrator.
583
* Contrary to what signtool says, the capicom dll must be copied from C:\Program Files\Microsoft SDKs\Windows\v6.0A\bin to C:\Windows\System32 and must be registered by typing the following at a Command Prompt run as Administrator: 
584
585
~~~~~~
586 74 David Alexander
cd C:\Windows\System32
587
REGSVR32 capicom.dll
588
~~~~~~
589
590
## NSIS
591
592
NSIS is a scriptable installer maker.
593
594
* Install NSIS from [NSIS Download Site](http://nsis.sourceforge.net/Download).
595
    * For building CMake 64bit and if you are building the composers, you will need a generator for installer executables, which is NSIS (Nullsoft Scriptable Install System) a professional open source system to create Windows installers.
596 88 John Cary
    * Version 2.46 is available as of Aug 21, 2011.
597
* Add `C:\Program Files (x86)\NSIS\Bin` to your system path.
598 74 David Alexander
599
* Install NSIS Access Control Plugin from [Access Control Plugin Site](http://nsis.sourceforge.net/AccessControl_plug-in).
600
601
Copies directories and files into the NSIS installation as follows:
602
603
~~~~~~
604
AccessControl.zip\Contrib\AccessControl --> NSIS\Contrib\AccessControl
605
AccessControl.zip\Docs\AccessControl --> NSIS\Docs\AccessControl
606 1 Redmine Admin
AccessControl.zip\Plugins\AccessControl.dll --> NSIS\Plugins\x86-ansi\AccessControl.dll
607
AccessControl.zip\Unicode\Plugins\AccessControl.dll --> NSIS\Plugins\x86-unicode\AccessControl.dll
608
~~~~~~
609
610
# Notes For Development
611
612
[[Notes on debugging Windows executables]]
613
[[Notes on deleting directories and files owned by other users]]