Project

General

Profile

Preparing a Windows machine for Bilder » History » Version 158

John Cary, 06/03/2021 01:13 PM

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 112 David Alexander
_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.
6 1 Redmine Admin
7
# Basic Windows Configuration
8
9 112 David Alexander
## UAC
10 1 Redmine Admin
11 112 David Alexander
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! The UAC Settings must be adjusted to "never notify" (this action is needed to make symbolic links during bilder runs and building Atlas). \
12 1 Redmine Admin
13 152 John Cary
## File Name too long
14
15
This can be a problem when cloning Trilinos.  To fix, see https://www.techinpost.com/the-file-name-too-long/.  In essence, use regedit to go to
16
```
17
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem
18
```
19
where you can set LongPathsEnabled to 1, then reboot.
20
21 112 David Alexander
## Editing your system path on Windows
22
23 1 Redmine Admin
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.
24
25 112 David Alexander
## If your machine is on a Windows Domain (as compared to a WORKGROUP), then ensure that Windows knows its domainname
26 1 Redmine Admin
27 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.
28 89 David Alexander
29 1 Redmine Admin
* From a command prompt, type the command: 
30
31
~~~~~~
32
ipconfig /all
33
~~~~~~
34
35 96 David Alexander
Look for the value of the "Primary Dns Suffix" field, which should be your domain name (i.e. txcorp.com).
36 1 Redmine Admin
37
* If cygwin is already installed,
38
39
~~~~~~
40
ipconfig /all | grep -i "Primary Dns Suffix" | sed -e 's/^.*: //'
41
~~~~~~
42
43 89 David Alexander
should return the domainname. 
44 1 Redmine Admin
45
* For Windows 7/Windows 2008 machines that are not a member of the Windows Domain, Active Directory, do the following:
46
    1. Right click on My Computer, select properties
47
    2. Click on Advanced system settings
48
    3. Select the computer name tab
49
    4. Click the change button
50
    5. Click the more button
51
    6. Enter the Primary DNS suffix. i.e. txcorp.com 
52
53 112 David Alexander
## Create initial directories
54 1 Redmine Admin
55
* Create the folder C:\\bin (if not already present).
56
* Add or move C:\\bin to the front of your system path.
57
58 113 David Alexander
# Software "Required" for Bilder
59 1 Redmine Admin
60 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
61 37 John Cary
62 74 David Alexander
* Blat (for emailing yourself)
63 36 John Cary
* Cygwin (for bash shell)
64 1 Redmine Admin
* CMake from an installer
65 157 John Cary
* NASM from an installer
66 38 John Cary
* Python from an installer
67
* Latex (MikTek below)
68 1 Redmine Admin
* Visual Studio Express (for nmake)
69 36 John Cary
70 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.
71
72 144 David Alexander
Since bilder uses the C++17 conformance flags, we require:
73 82 John Cary
74 144 David Alexander
* Visual Studio 2017 version 15.7 or higher (As of Oct 2019 the latest upgrade version is 15.9.17, which is fine)
75 83 John Cary
* Windows 10 or Windows 10 SDK
76
77 74 David Alexander
Below is a list of the Tools and Libraries that are most often needed.
78
79
# Tools (Required for most common builds within Bilder)
80
81 1 Redmine Admin
## Blat
82
83 74 David Alexander
*Blat is a sendmail client for Windows needed to send emails.*
84 1 Redmine Admin
85 149 David Alexander
* Download Blat from [The Blat SourceForge](http://sourceforge.net/projects/blat) Site and extract all files. The latest version should be fine.
86 150 David Alexander
* Extract the zip file (e.g. blat3222_32.full.zip) into C:\\bin.
87
* Copy the contents of the "full" directory up two diretories into "C:\bin" (i.e. C:\bin\blat3222\full\blat.{exe,dll} to C:\bin\blat.{exe,dll}).
88
* Execute the following command in a cygwin terminal to check that it works
89 1 Redmine Admin
90
~~~~~~
91
    blat -install mail.txcorp.com <username>@txcorp.com
92
~~~~~~
93
94
## CMake
95
96 74 David Alexander
*CMake is a cross-platform build system needed to configure many of necessary packages.*
97 1 Redmine Admin
98
* Install [CMake (a 32-bit application)](http://www.cmake.org/files/).
99 148 David Alexander
  * Version 3.16 is what we use as of Aug 2020.  Picking a later version is better because it will allow bilder to build future versions of cmake.
100 26 John Cary
  * Add the CMake path to the front of the system path! (Needed to build newer 64 bit versions through Bilder)
101 1 Redmine Admin
  * When this step is complete, make sure the newest CMake is the only one in your system path.
102
103 10 Redmine Admin
## CYGWIN
104 1 Redmine Admin
105 74 David Alexander
*Cygwin is a Unix shell program for Windows and is needed to run the bash code of Bilder.*
106
107 1 Redmine Admin
### Gotchas (in advance)
108
109
* Do not install Cygwin's MinGW. Those are installed in a separate area to reduce conflicts.
110
* 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'.
111
* Do not install Cygwin's mt.  If 'which mt' returns /bin/mt or /usr/bin/mt, then move this aside too.
112 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.)
113 1 Redmine Admin
* Make sure that 'which find' returns the cygwin version (/usr/bin/find), not the Windows version.
114
* Make sure 'which cmd' returns the Windows version. If not, check that your bash_profile has not made an error in setting your path.
115
* 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.
116
117
### Updating Cygwin
118
119
* 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.
120
* 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.
121
* Recreate the /etc/passwd and /etc/group file again using the mkpasswd and mkgroup commands described in the Configuring Cygwin section.
122
* 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).
123
* Upon running setup-*.exe, select the packages:
124 3 Redmine Admin
  * Base -> util-linux
125
  * Devel -> bison
126
  * Devel -> flex
127 4 Redmine Admin
  * Devel -> gcc-g++ and gcc-fortran (4.9.3 does not compile sqlite, so choose 4.9.2)
128 3 Redmine Admin
  * Devel -> git
129
  * Devel -> make
130
  * Devel -> mercurial
131 1 Redmine Admin
  * Devel -> patch
132 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.)
133 3 Redmine Admin
  * Editors -> vim and emacs (and alternate editors of choice)
134
  * Math -> bc
135
  * Net -> openssh
136 25 Matt Copper
  * Net -> curl
137 3 Redmine Admin
  * Python -> python (see note below)
138
  * Shells -> mintty
139
  * Utils -> diffutils
140
  * Utils -> dos2unix
141
  * Web -> wget
142 1 Redmine Admin
143
* 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).
144
145
* 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.
146
* 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.
147
148
### Setting Cygwin Disk Mounts
149
150
* 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:
151
152
~~~~~~
153
mkdir /cygdrive/c/winsame
154
mkdir /winsame
155
mount C:/winsame /winsame
156
~~~~~~
157
158
To make this permanent, put
159
160
~~~~~~
161
C:/winsame /winsame ntfs binary 0 0
162
~~~~~~
163
164
as one line in /etc/fstab.
165
166
On Windows-64, additionally put
167
168
~~~~~~
169
C:/Program\040Files\040(x86) /ProgramFilesX86 ntfs binary 0 0
170
~~~~~~
171
172
as one line in /etc/fstab.  This allows one to construct a valid path with no parentheses as needed for ATLAS.
173
174
### Configuring Cygwin
175
176 6 Redmine Admin
* Use a "Cygwin64 Terminal" from basic cygwin installation above to perform all subsequent bash tasks
177 1 Redmine Admin
178
* If bilderizing a domain machine, create an /etc/passwd file with the following command
179
180
~~~~~~
181
mkpasswd -l -d -p /winsame > /etc/passwd
182
~~~~~~
183
184 71 Tech-X Corporation
* Add a single domain user to an already created /etc/password:
185
186
~~~~~~
187
mkpasswd -l -d -u {username} -p /winsame >> /etc/passwd
188
~~~~~~
189
190 1 Redmine Admin
* If bilderizing a non-domain machine, create an /etc/passwd file with the following command
191
192
~~~~~~
193
mkpasswd -l -p /winsame > /etc/passwd
194
~~~~~~
195
196
* If bilderizing a domain machine, create an /etc/group file with the following command
197
198
~~~~~~
199
mkgroup -l -d > /etc/group
200
~~~~~~
201
202
* If bilderizing a non-domain machine, create an /etc/group file with the following command
203
204
~~~~~~
205
mkgroup -l > /etc/group
206
~~~~~~
207
208
* 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:
209
210
~~~~~~
211
cp /home/<username>/.* /winsame/<username>/
212
rm -rf /home/<username>
213
~~~~~~
214 52 John Cary
215 146 David Alexander
## Dependencies Tool
216 52 John Cary
217 146 David Alexander
*Dependencies* is a tool that shows the DLL's that an executable depends on and is needed to find and copy-in DLLs to a final distribution.
218 5 Redmine Admin
219 151 John Cary
Download [Dependencies](https://lucasg.github.io/Dependencies/) and copy Dependencies*, ClrPhlib.{dll,pdb} into C:\\bin.
220
(NDesk.Option.dll not needed.)
221 1 Redmine Admin
222
## JOM
223
224 74 David Alexander
*JOM is an nmake wrapper needed to give  the -j flag capability of Unix make for faster compilation.*
225 1 Redmine Admin
226
* Create the folder C:\bin (if not already present).
227
* Add C:\bin to your system path (if not already there).
228
* Download jom.zip from [the Qt Project](https://wiki.qt.io/Jom).
229
* Extract the contents of jom.zip
230
* Move/copy jom.exe to C:\bin (you then can delete the remainder of the contents or keep for historical reasons).
231
232
## LaTeX
233
234 74 David Alexander
*LaTeX is a typesetting tool needed for building PDF files for user documentation.*
235 1 Redmine Admin
236 123 Benjamin Cowan
* Install [Doxygen](http://www.doxygen.nl/).  Choose "Letter" for paper size and "Yes" for "Install missing packages on-the-fly".
237 92 John Cary
* Install Basic MikTeX from [MikTeX](http://miktex.org/). Use the MikTeX Package Manager to install the packages noted at
238
[[LaTeX packages needed by Bilder]]
239 124 Benjamin Cowan
* Install [ghostscript](https://www.ghostscript.com/download/gsdnld.html).
240 1 Redmine Admin
241
242
## MPI
243
244 74 David Alexander
*MPI is a message passing interface for parallel code that is needed for some computation engines.*
245
246 98 Ted Sume
Download Microsoft MPI v8.1.1 from:
247 1 Redmine Admin
248 98 Ted Sume
https://www.microsoft.com/en-us/download/details.aspx?id=55991
249 1 Redmine Admin
250 93 John Cary
The binaries (e.g., mpiexec) are obtained by installing msmpisetup.exe.
251 1 Redmine Admin
252 94 John Cary
The libraries (msmpi.lib) are obtained by installing msmpisdk.msi.
253 1 Redmine Admin
254 93 John Cary
The installers will put mpiexec in your path and define the environment variables,
255
256
MSMPI_INC
257
MSMPI_BIN
258
MSMPI_LIB32
259
MSMPI_LIB64
260
261
which are used by CMake, e.g., to find the needed components of MSMPI.
262 157 John Cary
263
## NASM (required to build OpenSSL, therefore CMake)
264
265
* Download and install from https://nasm.us/
266 158 John Cary
* Make sure this appropriate modifications to your path are made
267 1 Redmine Admin
268 85 John Cary
## Perl (required to build OpenSSL, therefore CMake)
269 1 Redmine Admin
270 74 David Alexander
*Perl is a programming language needed by some packages such as Qt*
271 1 Redmine Admin
272
* Download and install [ActiveState Perl](http://www.activestate.com/activeperl/downloads).
273
274
## Python
275
276 74 David Alexander
*Python is a programming language needed by many packages. Namely, any Python module needs Python to be installed.*
277
278 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.
279 1 Redmine Admin
280 107 John Cary
## RCEDIT
281
282
* 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.
283
284 85 John Cary
## Ruby (required to build Qt5)
285
286
* Ruby, http://rubyinstaller.org/, must be installed first.
287
288 1 Redmine Admin
## Subversion
289
290 74 David Alexander
* Subversion is a revision control tool needed by bilder, for example, to know when packages are out of date.*
291 1 Redmine Admin
292 108 Benjamin Cowan
* Install [TortoiseSVN](https://tortoisesvn.net/downloads.html) with its command line tools.
293 1 Redmine Admin
294 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).
295 33 Tech-X Corporation
296 1 Redmine Admin
~~~~~~
297
$ where svn
298 84 John Cary
C:\cygwin64\bin\svn.exe
299
C:\PROGRAM FILES\TORTOISESVN\bin\svn.exe
300
$ /usr/bin/svn --version | head -1
301
svn, version 1.9.7 (r1800392)
302
$ /cygdrive/c/Program\ Files/TortoiseSVN/bin/svn --version | head -n 1
303
svn, version 1.9.7 (r1800392)
304 15 Redmine Admin
~~~~~~
305 1 Redmine Admin
306
## Visual Studio
307 15 Redmine Admin
308 74 David Alexander
*Visual Studio contains the Microsoft command-line compiler (cl) used by packages with C/C++ code.* 
309
310 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.
311
312
    * VS12: Visual Studio 2013 Community Edition from Microsoft [VS12 Download Site](https://www.visualstudio.com/en-US/products/visual-studio-community-vs)
313
314
* 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).
315
316
* Ensure that Visual Studio is not in the system path. (Bilder adds this as needed.)
317 7 Redmine Admin
318 26 John Cary
### Compatibility with Python
319 7 Redmine Admin
320 1 Redmine Admin
* Python is built by Bilder.
321
322 78 Ted Sume
### Compatibility with CUDA 9.1 
323
* 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.
324 74 David Alexander
325 141 David Alexander
## LLVM-Clang
326
327 145 John Cary
You may want LLVM-Clang to be able to have OpenMP on Windows.  If that is not needed, you can skip it. Otherwise you can either install an LLVM-Clang installer or build LLVM-clang from source.
328
329
### Installing LLVM-Clang from a binary installer (easiest way)
330
331
Download the Windows (64-bit) installer from http://releases.llvm.org/download.html, and proceed with the installation..
332
333
### Building LLVM-Clang from source
334
335
We are currently using the `<Release Branch Name>=release/8.x branch` which is at `<Version>=8.0.1` as of September 2019, available from https://github.com/llvm/llvm-project .  Check out the llvm-project via GIT:
336 141 David Alexander
337
~~~~~~~~~~
338
cd /winsame/builds-llvm_vs2017 # Create directory if it doesn't exist already.
339
git clone -b <Release Branch Name> https://github.com/llvm/llvm-project.git llvm-<Version>
340
~~~~~~~~~~
341
342
To configure and build (in a cygwin terminal where you have sourced a machines file, e.g. cygwin.vs2017, from a checkout of bilder):
343
344
~~~~~~~~~~
345
cd /winsame/builds-llvm_vs2017/llvm-<Version>
346
mkdir build
347
cd build
348
cmake \
349
  -DCMAKE_INSTALL_PREFIX:PATH=D:/winsame/builds-llvm_vs2017/llvm-<Version>/install \
350
  -DCMAKE_BUILD_TYPE:STRING=Release \
351
  -DCMAKE_C_COMPILER:FILEPATH='<Windows path to cl.exe>' \
352
  -DCMAKE_CXX_COMPILER:FILEPATH='<Windows path to cl.exe>' \
353
  -DCMAKE_C_FLAGS:STRING='/W3' \
354
  -DCMAKE_CXX_FLAGS:STRING='/W3 /GR /EHsc' \
355
  -DLLVM_ENABLE_PROJECTS="clang;openmp" -DLLVM_ENABLE_RTTI:BOOL=ON -DLLVM_ENABLE_EH:BOOL=ON \
356
  -G 'NMake Makefiles JOM' \
357
  ../llvm
358
jom
359
jom install
360
~~~~~~~~~~
361
362
Bilder will look for /winsame/builds-llvm_vs2017/llvm-current, so we set a link to the version we want to use (Bilder will also look in $LLVM_DIR and in your installation directory, for checking builds with multiple versions):
363
364
~~~~~~~~~
365
cd /winsame/builds-llvm_vs2017
366
ln -s llvm-<Version>/install llvm-current
367
~~~~~~~~~
368
369 153 Ted Sume
# WSL on Windows 10 1909 or newer 
370
371
* From within an Administrator enable Powershell window, run the following
372
373
```
374
dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
375
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
376
```
377
* Reboot the computer after running the above two commands from within Powershell
378
* Update Kernel for WSL2 by downloading and installing https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi
379
* Run the following command from within an Administrator enabled Powershell window to set the default WSL version to 2.
380
381
```
382
wsl --set-default-version 2
383
```
384
* Go to Microsoft store, search for preferred Linux distro, download and install per on screen instructions.
385
386
387 1 Redmine Admin
# Libraries (Required for most builds with Bilder)
388
389
## OpenSSL
390
391 85 John Cary
*OpenSSL is a security library needed by Python to build the SSL module, by cmake, libssh, and by Qt.*
392
*We no longer install OpenSSL on Windows, as Bilder builds it to be consistent with the compiler in use."
393 1 Redmine Admin
394 85 John Cary
### Legacy instructions.
395
396 1 Redmine Admin
* Download from http://slproweb.com/products/Win32OpenSSL.html
397 75 John Cary
* Choose the Win64 OpenSSL v1.0.2n  (not Light) on 64bit or the Win32 OpenSSL v1.0.2n on 32bit windows.
398 76 John Cary
* **The 1.1 series DOES NOT WORK with either libssh or Qt.**
399 1 Redmine Admin
* You may have to install Visual C++ Redistributables if the installer complains.
400
* During the installation, select "Copy OpenSSL DLLs to: The OpenSSL binaries (/bin) directory"
401
* 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.
402
* 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:
403
404 30 John Cary
~~~~~~
405
which libeay32.dll
406 1 Redmine Admin
/cygdrive/c/OpenSSL-Win64/bin/libeay32.dll
407 73 Tech-X Corporation
~~~~~~
408 30 John Cary
409 1 Redmine Admin
* If built software has unexplained crashes, recheck the above command results.
410
411 109 Tech-X Corporation
412
# Composer-related Libraries (only needed for building ComposerToolkit, can be skipped for documentation builds)
413
414 125 Nathan Neri
## Git LFS
415
416
*Git LFS is a git extension for repos with large files - needed to use git for VisIt repos*
417
418
Download and run the installer: https://git-lfs.github.com/
419
420 130 Nathan Neri
You can adjust the configuration by running (from Cygwin) `git lfs install --force --skip-smudge` with new configuration options.
421 125 Nathan Neri
422 127 Nathan Neri
To ensure that git will find git lfs, add a symbolic link from git's exec path to the location of the git-lfs executable.
423
424
~~~~~~
425
LINK_TO_PATH=`which git-lfs.exe`
426
LINK_FROM_PATH=`git --exec-path`
427
cd $LINK_FROM_PATH
428
ln -s "$LINK_TO_PATH" git-lfs.exe
429
~~~~~~
430
431 74 David Alexander
## Qt
432 1 Redmine Admin
433 74 David Alexander
*Qt is a cross-platform GUI library needed to build packages that have Qt-based user interfaces.*
434
435 142 David Alexander
Qt5 is the recommended version (the previous version, Qt4, instructions are also here too until Qt5 is solid).
436 1 Redmine Admin
437 142 David Alexander
### Installing Qt5
438
439
These instructions are how to install the pre-built version of Qt 5 (version 5.12.5).  You can skip creating the Qt account.
440
441
* Get Qt-5.12.5 from http://download.qt.io/official_releases/qt/5.12/5.12.5/qt-opensource-windows-x86-5.12.5.exe
442
* Run this program, selecting `<DRIVE>\winsame\winqt\5.12.5` as your installation directory, where DRIVE is the drive you have winsame on (e.g. D: or C:). (Bilder will find Qt5 if it is here)
443
* Select the following components:
444
  * MSVC 2017 64-bit
445
  * Sources
446
  * Qt WebEngine
447
* Optionally, under Tools select:
448
  * Qt Creator 4.8.1 CDB Debugger Support
449
  * Qt Creator 4.8.1 is selected by default
450
* Accept all remaining defaults unless otherwise preferred
451
452 143 David Alexander
### Building and Installing Qt4
453 74 David Alexander
454 41 John Cary
* Make sure no other Qt is in your system path.
455 114 Nathan Neri
* Get the Qt Libraries from http://download.qt.io/archive/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.)
456 118 Nathan Neri
* Run this program, selecting C:\winsame\builds-XX\winqt\4.8.7 as your installation directory, where XX is the machines file suffix you use (e.g. vs2017).
457 41 John Cary
* If 4.8.7, patch Qt by opening a Cygwin window:
458 1 Redmine Admin
459
~~~~~~
460
cd /winsame/builds-vs12/winqt/4.8.7
461 100 John Cary
~~~~~~
462
463 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
464 100 John Cary
465
~~~~~~
466 119 Nathan Neri
/path/to/bilder/installed/python -m patch /path/to/bilder/patches/02-fix_build_with_msvc2015-45e8f4ee.diff
467 1 Redmine Admin
~~~~~~
468
469 74 David Alexander
#### Compiling Qt4
470 1 Redmine Admin
471
* The copy/paste-able commands below assume VS12.
472
473
In a Visual Studio x64 DOS window:
474
475
~~~~~~
476 116 Nathan Neri
set VER=2017
477
REM could be 12
478 120 Nathan Neri
set DRIVE=C:
479
REM or D:, if you're building there
480 1 Redmine Admin
set SFX=vs%VER%
481
REM or whatever machine suffix you will be building for, if using a combined compiler build
482
set QTVER=4.8.7
483 120 Nathan Neri
set INSTALL_DIR=%DRIVE%\winsame\builds-%SFX%\winqt\%QTVER%\%QTVER%\msvc%VER%_64
484 1 Redmine Admin
~~~~~~
485
486 103 John Cary
Modify the last line as needed, e.g., different drive or subdir.
487 1 Redmine Admin
488 106 John Cary
Set the platform args according to your compiler.
489 1 Redmine Admin
490 106 John Cary
For VS2013 (VS12).
491
492 101 John Cary
~~~~~~
493 106 John Cary
set PLATFORM_ARGS=-platform win32-msvc2013
494 101 John Cary
~~~~~~
495
496 106 John Cary
For VS2015 or VS2017:
497 101 John Cary
498
~~~~~~
499 106 John Cary
set PLATFORM_ARGS=-platform win32-msvc2015
500 101 John Cary
~~~~~~
501 1 Redmine Admin
502
Then
503
504
~~~~~~
505 120 Nathan Neri
%DRIVE%
506
cd %DRIVE%\winsame\builds-%SFX%\winqt\%QTVER%
507 116 Nathan Neri
configure.exe -prefix %INSTALL_DIR% -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%
508 1 Redmine Admin
~~~~~~
509
510
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)
511
512 106 John Cary
~~~~~~
513 99 John Cary
export VER=12 # or 2017
514
export SFX=vs${VER}
515 44 John Cary
cd /winsame/builds-${SFX}/winqt/4.8.7
516 115 John Cary
export INSTALL_DIR=/winsame/builds-${SFX}/winqt/4.8.7/4.8.7/msvc${VER}_64
517
mkdir -p ${INSTALL_DIR}
518 139 David Alexander
cp -R mkspecs ${INSTALL_DIR}
519 128 Nathan Neri
~~~~~~
520
521 137 David Alexander
Back in the Visual Studio x64 DOS window
522 128 Nathan Neri
523
~~~~~~
524
%DRIVE%
525
cd %DRIVE%\winsame\builds-%SFX%\winqt\4.8.7 
526 1 Redmine Admin
set PATH=%PATH%;%DRIVE%\winsame\builds-%SFX%\winqt\4.8.7\bin
527
nmake
528 128 Nathan Neri
REM Took 3.5 hours on a 2.3 GHz Core2 Duo with Solid State Drive
529
nmake install
530
REM Took 10 minutes on a 2.3 GHZ Core2 Duo with Solid State Drive
531
~~~~~~
532
533 1 Redmine Admin
* For CMake to find Qt, add INSTALL_DIR to your supra search path when configuring.
534
535 142 David Alexander
* If you want to use this qt outside of Bilder, add ${INSTALL_DIR}/bin to the system path variable.  This may not work if you have more than one Bilder run.
536
537 140 David Alexander
538
# Additional Useful Tools
539
540
## Notepad++
541
542
* (Optional) Notepad++ is a free source code editor that is a great tool for Windows.
543
* Download from http://notepad-plus-plus.org/
544
* Install and pin to your taskbar.
545 1 Redmine Admin
546 110 David Alexander
## Java
547
548
Java is needed for setting up the machine to be a Jenkins Slave.
549
550
* Download from https://www.java.com/en/download/  (Version 8 Update 181 has a Release date of July 17, 2018) 
551
* May get a message about the Java Plugin and Chrome. This does not affect the Jenkins slave service.
552 111 David Alexander
* Download the JNLP page from the Jenkins server site (link button with label "Launch agent from browser").
553
* Start a command prompt running as Administrator, then change to the Download directory and type "javaws slave-agent.jnlp" 
554 110 David Alexander
* Choose File -> "Install as a service" and follow the dialog messages.
555
556 1 Redmine Admin
# Experimental Tools and Libraries
557
558
These tools have not been fully vetted or built, so you need not do these.
559
560
## MinGW
561
562
See [[Installing MinGW]].
563
564
## ATLAS
565
566
See [[Installing ATLAS on Windows]].
567 8 Redmine Admin
568 131 John Cary
## OpenBLAS
569
570
See [[Installing OpenBlas on Windows]]
571
572 1 Redmine Admin
# Cygwin and Paths
573 8 Redmine Admin
574 1 Redmine Admin
(This section assumes the user is familiar with the relations between Cygwin and Windows paths.)
575
576
The path is critical for when there are conflicting executables.  This is the case for Subversion and OpenSSL.
577
578
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.
579
580
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.
581
582
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.
583
584
## Usage under Jenkins
585
586
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.
587
588
589
## Summary
590
591
* Bilder moves `/usr/bin` to just after the Python path and therefore to before
592
  `/cygdrive/c/Windows/system32`.
593
* Put the Windows Subversion path behind the Python path (and so behind `/usr/bin`).
594
    - `/usr/bin` must be removed from the path when configuring some packages in order to get the correct subversion when building under Jenkins.
595
596
# Bilder machine files for cygwin
597
598
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.
599
600
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.
601
602
# Setup for making Installers
603
604
## Visual Studios Redistributables
605
606
Download vcredist_x64.exe (Visual C++ Redistributable Packages for Visual Studio 2013)
607
608
http://www.microsoft.com/en-gb/download/details.aspx?id=40784
609
610
Choose only vcredist_x64.exe executable from list. Put executable in C:\bin.
611
612
## Sign Tools
613
614
* 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.
615
* 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: 
616
617
~~~~~~
618 74 David Alexander
cd C:\Windows\System32
619
REGSVR32 capicom.dll
620
~~~~~~
621
622
## NSIS
623
624
NSIS is a scriptable installer maker.
625 1 Redmine Admin
626
* Install NSIS from [NSIS Download Site](http://nsis.sourceforge.net/Download).
627 131 John Cary
  * 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.
628
  * Version 2.46 is available as of Aug 21, 2011.
629 88 John Cary
* Add `C:\Program Files (x86)\NSIS\Bin` to your system path.
630 74 David Alexander
631
* Install NSIS Access Control Plugin from [Access Control Plugin Site](http://nsis.sourceforge.net/AccessControl_plug-in).
632
633
Copies directories and files into the NSIS installation as follows:
634
635
~~~~~~
636
AccessControl.zip\Contrib\AccessControl --> NSIS\Contrib\AccessControl
637
AccessControl.zip\Docs\AccessControl --> NSIS\Docs\AccessControl
638 1 Redmine Admin
AccessControl.zip\Plugins\AccessControl.dll --> NSIS\Plugins\x86-ansi\AccessControl.dll
639
AccessControl.zip\Unicode\Plugins\AccessControl.dll --> NSIS\Plugins\x86-unicode\AccessControl.dll
640
~~~~~~
641
642 155 David Alexander
643
# Path
644
645
The resulting Windows PATH should look like this...
646
647 156 David Alexander
![](windowsPath.png)
648 155 David Alexander
649 1 Redmine Admin
# Notes For Development
650
651
[[Notes on debugging Windows executables]]
652
[[Notes on deleting directories and files owned by other users]]
653 154 Ted Sume
[[Notes on enabling and disabling the Windows Firewall from the command line]]