Version Management

The tool that is used to manage the development of the MCTDH-X software is Mercurial, in terminal, hg. It is available on most Unix-based systems and facilitates the contribution of multiple developers to a project. Mercurial is a distributed version management system, i.e., each user of it has the the full version history available locally. The basic operations are collected in the following list:

1. making a full copy of a repository with hg clone <repository location>
2. creating branches with hg branch <branch name>.
3. showing a summary of the changes with respect to the last revision by hg status
4. adding and removing files by hg add <files> and hg remove <files>
5. add all new files and remove all missing files with hg addremove
6. showing the history of commit messages for all revisions by hg log
7. add a version number to your revision with hg tag <version label>. The structure of the version label is explained below.
8. commiting changes made to a revision of the repository as a new revision with hg commit -u <username>
9. pushing or pulling the changes made in the present repository to another repository by hg push <repository location> or hg pull <repository location>.
10. updating the repository after pulling/pushing a changeset by hg update

It is important to note here that the version management of the central repository is not open for all users. If you are interested in contributing, write an email to the developers at mctdhx@ultracold.org to obtain an account for the software repository.