docs/src/install.md

Wed, 28 Jun 2023 19:18:01 +0200

author
Mike Becker <universe@uap-core.de>
date
Wed, 28 Jun 2023 19:18:01 +0200
changeset 726
44986c0e2b05
parent 721
b79340dee0b4
child 737
b3b113eac3b8
permissions
-rw-r--r--

add a low-level stdlib-based cx_reallocate()

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
721
b79340dee0b4 update install instructions for ucx 3.0
Mike Becker <universe@uap-core.de>
parents: 390
diff changeset
12 Then create a build directory and use cmake to create the build files,
b79340dee0b4 update install instructions for ucx 3.0
Mike Becker <universe@uap-core.de>
parents: 390
diff changeset
13 execute the build, and - optionally - install the files.
390
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
14
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
15 mkdir build
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
16 cd build
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
17 cmake ..
721
b79340dee0b4 update install instructions for ucx 3.0
Mike Becker <universe@uap-core.de>
parents: 390
diff changeset
18 cmake --build .
b79340dee0b4 update install instructions for ucx 3.0
Mike Becker <universe@uap-core.de>
parents: 390
diff changeset
19 sudo cmake --install .
390
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 ---
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 ### UCX 2.1
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
24
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
25 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
26 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
27 tools (like MinGW or Cygwin).
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
28 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
29
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
30 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
31 tar -xzf ucx-2.1.0.tar.gz
d345541018fa starts ucx 3.0 development
Mike Becker <universe@uap-core.de>
parents: 264
diff changeset
32 cd ucx-2.1.0
259
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 Then issue the `configure` and `make` commands.
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 ./configure && make
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
37
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
38 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
39 you can install UCX with
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 make install
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
42
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
43 Note, that you might need administrative privileges for a system wide
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
44 installation.
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
45
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
46 [1]: https://sourceforge.net/projects/ucx/files/
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
47

mercurial