Choose your ProDiMo version¶
If you have not updated the code for a while, you might not yet have the required 2FA activated. In that case, please look at Personal access token.
Using a released version (recommended)¶
ProDiMo receives regular improvements and bug corrections. However, it is recommended to always work with a tagged version of ProDiMo (ideally the last one), if possible (see available versions and the changelog). Those tagged versions are supposed to be stable and tested releases, contrary to the master branch, where changes can happen anytime.
To use a tagged version, type in your ProDiMo directory (here for version v3.0.0)
git fetch
git switch --detach v3.0.0
After that, please recompile the code (use make realclean first, then make; see Compile the code). When you run ProDiMo, you see the version used at the beginning of the screen/log output.
Working with the master branch¶
It is not recommended for users to work with the master branch, but it might be necessary if one wants to use the latest features. To use the latest version of ProDiMo, you need to switch to the master branch, e.g.
path/to/ProDiMo > git switch master
Or checkout for older git versions.
To update the code, type
path/to/ProDiMo > git pull
Sometimes it is necessary to switch back to a specific revision/commit. This can be done this way:
path/to/ProDiMo > git pull
path/to/ProDiMo > git checkout COMMITSHA
COMMITSHA is a unique identifier of each commit to the git repository. You can find this identifier, for example, in the commit lists in the GitLab web interface. However, one can also list them from the command line:
path/to/ProDiMo > git log -3 --oneline
lists the last three commits and shows the COMMITSHA at the beginning.
You can do the following to get back to the latest ProDiMo version.
path/to/ProDiMo > git checkout master
In any case, after a checkout or git pull, please recompile the code (use make realclean, first see also Compile the code) to make sure you are really using the revision you wanted. Once you run ProDiMo, the COMMITSHA is also logged at the very beginning of the run (look for Revision: )
Switch back to an SVN revision (ancient version)¶
ProDiMo used Subversion (svn) for version management in the past. Sometimes, one knows only the SVN revision number (e.g., from a paper or ProDiMo log file), but not the git COMMITSHA. However, all the information from SVN was migrated into git, and one can find the git commit corresponding to a revision number like this.
git log --grep=version0.7@2730
Here, the desired revision number is 2730. One should get an output like that:
commit 42c92cde15397b5dd52e02437150f3d3dd4c739c
Author: Christian Rab <email@email.de>
Date: Fri Nov 11 17:02:47 2016 +0000
smaller bugfixes for the ## species.
git-svn-id: https://forge.roe.ac.uk/svn/ProDiMo/trunk/version0.7@2730 60d36250-7b4e-4c91-aced-c0dc02460296
The first line shows the git COMMITSHA, which can be used to check out this particular version of the code (see above).