Installing the Software

If you only want to download and use (but not commit updates to!) the PADME software, you can obtain the lastest release from the main repository hosted on GitHub.

From any machine where git is installed give the following command:

git clone https://github.com/PADME-Experiment/padme-fw <localdir>

If <localdir> is omitted, a directory named padme-fw is created inside the current directory.

If you want to be able to commit your changes to the software, you must first register to GitHub, create and register a ssh key (see below), and then apply to join the PADME-Experiment developers team by sending a "request for access" e-mail to emanuele.leonardi@roma1.infn.it specifying the GitHub user name you created.

A ssh key can be created on any Linux node with the command

ssh-keygen -t rsa -b 4096 -C "your_email@your_site"

Inside the .ssh directory in your home directory you will find two files: id_rsa (private key) and id_rsa.pub (public key). To register this key into GitHub you have to copy the content of the public key file id_rsa.pub to the GitHub key registration page. This page is reachable from your GitHub home page with Your account (top right icon) -> Settings -> SSH and GPG keys -> New SSH key (choose any title you like).

After the registration is completed, you can get a local copy of the PADME software framework with the command:

git clone ssh://git@github.com/PADME-Experiment/padme-fw <localdir>

In general, you will want to use the develop branch of the framework, which contains a somewhat verified and up-to-date version of the software. The master branch is used for production specific tasks and is usually quite old, while other branches are used for incomplete development tasks and should not be used unless you know what you are doing.

To use the develop branch do

cd padme-fw
git checkout develop

Before doing any modification to the code, make sure to create a new branch based on develop and switch to it. As an example:

git checkout develop
git branch feature/mynewbranch
git checkout feature/mynewbranch