Working with the repository using Mercurial¶
This part of the tutorial will teach you how to create a workspace in the repository, clone the workspace from the model repository using a Mercurial client, add content to the workspace, and then push the cloned workspace to the repository.
Registering an account and logging in¶
First, navigate to the teaching instance of the Physiome Model Repository at http://teaching.physiomeproject.org/.
Note
The teaching instance of the repository is a mirror of the main repository site found at http://models.physiomeproject.org/, running the latest development version of the PMR Software.
Any changes you make to the contents of the teaching instance are not permanent, and will be overwritten with the contents of the main repository whenever the teaching instance is upgraded to a new PMR Software release. For this reason, you can feel free to experiment and make mistakes when pushing to the teaching instance. Please subscribe to the cellml-discussion mailing list to receive notifications of when the teaching instance will be refreshed.
See the section Migrating content to the main repository for instructions on how to migrate any content from the teaching instance to the main (permanent) Physiome Model Repository.
In order to make changes to models in the repository, you must first register for an account. If you already have an account on the main repository site, your account will also be on the teaching instance. Otherwise, you need to register for an account on the teaching repository. You can register by navigating to the Log in link at the top right of the menu bar and then looking for the New user section of the log in page.
Note
Your username and password are also the credentials you use to interact with the repository via Mercurial.
Once logged in to the repository, you will notice that there are a couple of new links in the navigation bar (My Workspaces and Documentation). The My Worskpaces link is where all the workspaces you create later on will be listed. The Log in link is also replaced by your username and a Log out link (which you can access by clicking on your username).
Mercurial username configuration¶
Important
Username setup for Mercurial
Since you are about to make changes, your name needs to be recorded as part of the workspace revision history. When you commit your changes using Mercurial, it is initially "offline" and independent of the central PMR Software instance. This means that you have to set-up your username for the Mercurial client software, even though you have registered a username on the PMR Software site.
You only need to do this once. The MAP PMR tool will help complete these details for you automatically, but it is a good idea to ensure sensible default values are configured, just in case.
Steps for TortoiseHg:
- Right click on any file or folder in Windows Explorer, and select .
- Select Commit and then enter your name followed by your e-mail address in "angle brackets" (i.e. less-than "<" and greater-than ">"). Actually, you can enter anything you want here, but this is the accepted best practice as your email address provides a globally unique identifier. Note that this information becomes visible publicly if the PMR Software instance that you push your changes to is public.
Steps for command line:
- Edit the config text file:
- For per repository settings, the file in the repository:
<repo>\.hg\hgrc - System-wide settings for Linux / OS X:
~/.hgrc - System-wide settings for Windows:
%USERPROFILE%\mercurial.ini
- For per repository settings, the file in the repository:
Add the following entry:
[ui] username = Firstname Lastname <firstname.lastname@example.net>