Getting the Source Code
Our source code is managed through our GitLab repository. Anyone can clone a copy of the repository as follows:
git clone http://gitlab.nektar.info/nektar/nektar.git nektar++
If you would like to contribute back to the project, we encourage you to create an account on our GitLab instance and clone the repository using these credentials.
- Visit our Gitlab website: https://gitlab.nektar.info and sign up for an account.
- If you do not already have an SSH key, generate one on your local computer (e.g. using the ssh-keygen utility on Linux). Take care not to overwrite any existing keys!
- In your profile, add the public part (e.g. contents of id_rsa.pub) under SSH keys.
- Clone the git repository using your account:
git clone email@example.com:nektar/nektar.git nektar++
Note: Do not modify the username git in the above command. All access to git is through the git user using the SSH key(s) configured in GitLab.
Archive packages for each release are also available here. You should unpack the tarball using:
tar -xvf [filename]
[filename] with the name of the downloaded file.
Compiling the code
The general process to compile on Linux-based operating systems is
cd nektar++-x.x.x mkdir build && cd build ccmake ../ make make install
x.x.x corresponds to the version of the code. The version number is omitted for code cloned from the git repository.
For details on the compilation process, and for instructions for other operating systems, please consult the User Guide.
Testing the code
After compilation is complete, the suite of tests can be run using