Download the code

The ProDiMo source code is stored in a Gitlab repository. To check out (download) the code, you need git on your machine. Usually, any Linux or Unix-like system, such as Mac OS X, has it.

We highly recommend using a git version >=2.30 (run git --version to check it). Please use your package manager to update git if needed (e.g., on Mac computers, one can use homebrew or use a conda environment). Knowledge of the basic git commands is required to update the code.

To get access to the source code of ProDiMo you need a user account for the https://gitlab.astro.rug.nl sever (contact one of the main developers).

Personal Access Token

As our GitLab server uses 2FA, a personal access token is required to access the git repository from the command line or a git client.

Log in with your user to the Kapteyn GitLab server, and go to Access tokens; click on your avatar at the top-right and Preferences. Choose a name for your personal token, tick the read_repository box, and then ´Create personal access token`. Your access token will appear at the top of the page; you need to save it. After that, you can use git from the command line or within a git client using your personal token. You can also create multiple tokens, or create a new on if you lose it.

Before we start we recommend to activate the git credentials helper:

git config credential.helper store

This will store your credentials in a file in your home directory, so you do not have to enter them every time you access the repository.

When you clone the repository, you will be asked for your username and password (access token). Enter your username and the access token as password.

Cloning the Repository

In a directory of your choice, simply type:

git clone https://YOURUSERNAME@gitlab.astro.rug.nl/prodimo/prodimo.git

Replace YOURUSERNAME with your account for the git ProDiMo repository. This command will then ask for your access token and create a directory prodimo within your current working directory.

This will download the ProDiMo git repository, which might take a bit. After the download is finished, you will find all the necessary files to run ProDiMo in the prodimo directory, and you can continue to compile and test the code.

If you would like to clone the repository into a different directory, use (replace YOURPRODIMODIR):

git clone https://YOURUSERNAME@gitlab.astro.rug.nl/prodimo/prodimo.git YOURPRODIMODIR

Some users experienced problems with the SSL connection; in that case, you can try

git clone -c http.sslVerify=false https://YOURUSERNAME@gitlab.astro.rug.nl/prodimo/prodimo.git YOURPRODIMODIR

Some Recommendations

As your ProDiMo installation is version-controlled, we recommend not storing anything else in that directory (e.g., model results).

However, in some cases, it might be required to change some files within that directory, for example, if you want to test something. And if you change something that you think should be fixed in the code or is useful for everybody, it should at some point also end up in the ProDiMo git repository. If you do not have developer rights, please get in touch with one of the main ProDiMo developers.