Mercurial > hg > ucx / annotate

docs/src/install.md@e075009b33b7 (annotated)

docs/src/install.md

Tue, 05 Oct 2021 11:19:32 +0200

author
Mike Becker <universe@uap-core.de>
date
Tue, 05 Oct 2021 11:19:32 +0200
changeset 460
e075009b33b7
parent 390
d345541018fa
child 721
b79340dee0b4
permissions
-rw-r--r--

remove convenience macros

Users should write their own wrappers s.t. the type
information does not have to be repeated on every
call site.

264
24f5484bae97 web doc has now proper titles
Mike Becker <universe@uap-core.de>
parents: 259
diff changeset
1 ---
24f5484bae97 web doc has now proper titles
Mike Becker <universe@uap-core.de>
parents: 259
diff changeset
2 title: Build Instructions
24f5484bae97 web doc has now proper titles
Mike Becker <universe@uap-core.de>
parents: 259
diff changeset
3 ---
259
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
4
390
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
5 The build processes uses CMake starting with UCX 3.0.
259
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
6 First, download the source code from [Source Forge][1].
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
7
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
8 wget https://sourceforge.net/projects/ucx/files/ucx-latest.tar.gz
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
9 tar -xzf ucx-latest.tar.gz
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
10 cd ucx-latest
390
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
11
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
12 Then create a build directory and issue the cmake command and then make.
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
13
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
14 mkdir build
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
15 cd build
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
16 cmake ..
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
17 make
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
18
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
19 ---
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
20
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
21 ### UCX 2.1
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
22
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
23 The build procedure for UCX 2.1 uses a configure script.
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
24 For Microsoft Windows, you will need an appropriate port of the linux
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
25 tools (like MinGW or Cygwin).
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
26 First, download the source code from [Source Forge][1].
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
27
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
28 wget https://sourceforge.net/projects/ucx/files/ucx-2.1.0.tar.gz
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
29 tar -xzf ucx-2.1.0.tar.gz
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
30 cd ucx-2.1.0
259
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
31
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
32 Then issue the `configure` and `make` commands.
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
33
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
34 ./configure && make
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
35
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
36 To verify your installment you can issue `make check`. If everything is fine,
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
37 you can install UCX with
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
38
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
39 make install
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
40
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
41 Note, that you might need administrative privileges for a system wide
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
42 installation.
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
43
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
44 [1]: https://sourceforge.net/projects/ucx/files/
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
45

Mercurial Repository: ucx

mercurial