Skip to content

Index

CERN Gitlab / GitHub instances#

There are two instances of this project:

  1. https://gitlab.cern.ch/atlas-flavor-tagging-tools/algorithms/umami
  2. https://github.com/umami-hep/umami

The primary instance is hosted by CERN at the GitLab instance. As only CERN computing accounts can have full access and make contributions, there is a second instance hosted by GitHub. The primary instance is regularly mirrored to the GitHub instance. The purpose of the GitHub instance is to allow everybody to report issues and open merge/pull requests which are then ported to the GitLab instance after they have been merged on GitHub.

Branch Workflow#

If you want to contribute to the development of Umami, you can clone the project and then should make changes inside a feature branch. When your feature is ready, open a merge request (GitLab) / pull request (GitHub) to the master branch. 

# option 1: clone from gitlab (CERN)
git clone ssh://git@gitlab.cern.ch:7999/atlas-flavor-tagging-tools/algorithms/umami.git
# option 2: clone from github (everyone)
git clone git@github.com:umami-hep/umami.git

# open new branch
git checkout -b dev_<feature_name>

Development guidelines#

Good coding standards are highly encouraged. You can find some more information in the development guide for Umami or in the coding style suggestions.

CERN users also have access to a coding tutorial (only for CERN users). In short, aim to write clean, readible and type-hinted code with module and function docstrings, and plenty of inline comments.

VS Code is the recommended editor when developing for Umami. See also the umami guide for development with VS Code.

Back to top