README.md 2.04 KB
Newer Older
1
Nightly runs on full testset: https://testboard.org/cdash/index.php?project=Dalton
Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
2

Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
3
4
5
6
7
8
9
## Dalton links

- [Home page](http://daltonprogram.org/)
- [Forum](http://forum.daltonprogram.org/)
- [Article](http://onlinelibrary.wiley.com/doi/10.1002/wcms.1172/abstract)


10
## Quick start
Radovan Bast's avatar
Radovan Bast committed
11

Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
12
13
14
15
16
Note that it is currently not practical to download the source using the
download button on GitLab, because it will not include the submodules that are
required to build Dalton. Instead you should clone the repository as described
below.

Radovan Bast's avatar
Radovan Bast committed
17
18
Clone the repository:
```
19
$ git clone --recursive https://gitlab.com/dalton/dalton.git
Radovan Bast's avatar
Radovan Bast committed
20
21
```

22
23
24
25
26
This will fetch the entire repository in a directory called *dalton*. By default
it checks out the master branch which is the main development branch. To
checkout a specific release version, run the following commands from inside the
*dalton* directory:
```
Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
27
$ git checkout Dalton2020.0
28
29
$ git submodule update
```
Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
30
where you replace *Dalton2020.0* by the release version that you are
Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
31
interested in. The list of past releases available in this repository can be
Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
32
33
34
35
36
37
found here: https://gitlab.com/dalton/dalton/-/releases.

You can also clone the release version directly as:
```
$ git clone --recursive -b Dalton2020.0 https://gitlab.com/dalton/dalton.git
```
38

Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
39
40
41
In case you did not include the `--recursive` argument when you cloned the
repository, it is necessary to run the following two commands:
```
Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
42
$ git submodule update --init --recursive
Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
43
44
45
```

To build the code, perform the following steps:
Radovan Bast's avatar
Radovan Bast committed
46
```
Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
47
$ ./setup
Radovan Bast's avatar
Radovan Bast committed
48
49
50
51
$ cd build
$ make [-j4]
```

Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
52
53
54
55
56
57
There are several setup options available, e.g., for setting up an MPI build.
To see the available options run:
```
$ ./setup --help
```

Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
58
Once the build is complete, you can run the test set as:
Radovan Bast's avatar
Radovan Bast committed
59
```
Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
60
$ ctest [-j4] -L dalton
Radovan Bast's avatar
Radovan Bast committed
61
62
```

Jógvan Magnus Haugaard Olsen's avatar
Jógvan Magnus Haugaard Olsen committed
63
To switch branch (or release tag), run the following two commands from the *dalton* directory:
64
65
66
67
68
69
70
71
```
$ git checkout feature-branch
$ git submodule update
```
This can also be achieved in one step when you clone the repository:
```
$ git clone --recursive -b feature-branch https://gitlab.com/dalton/dalton.git
```