MRtrix3 is finally about to come out of beta status and hit full release! This is the first release candidate for our forthcoming version 3.0 of MRtrix3, the result of many months of work, with many new features and improvements (see below). Hopefully the proper full release will follow shortly after a few weeks of community testing. You are all encouraged to upgrade and try it out - and if you do come across any issues, don’t hesitate to let us know, either on the community forum, or via the GitHub issue tracker: we’ll get them fixed straight away.
While the bulk of the functionality will behave as before, there are a number of changes in this version that you will need to know about, in particular:
differences in the file layout of the code repository: this is especially relevant if you are upgrading from a previous version - see detailed instructions below to avoid trouble.
the new fixel storage format.
Instructions for upgrading
The arrangement and naming conventions used in the repository structure have been altered, for reasons described here. This has the potential to introduce problems for users upgrading from previous versions - we therefore strongly recommend users follow the detailed upgrade instructions provided below.
Now that these instructions assume there was nothing unusual about your previous installation. If you needed to set any environment variables before, you will most likely need to do so again prior to running
update the code to the new version:
$ git pull
re-run the configure script:
build the executables:
Note that this step will automatically remove your previous
releasefolder if it exists. This is to avoid conflicts that might arise if the executables from the previous version of MRtrix3 remain in place and in your
PATHto reflect the new location:
Alternatively, you can add the MRtrix3
PATHyourself if you prefer. However, we recommend you use the
./set_pathscript to handle this step, unless you are comfortable with manipulating the
PATH, use a different shell, or have other specific requirements.
Note that if you had previously set your
PATHmanually, we recommend you remove this entry from the relevant shell startup script (most likely
close your terminal, start a fresh one, and verify that the commands used are the correct ones, e.g.:
$ mrinfo --version == mrinfo 3.0_RC1 == ...
Don’t worry if the version is reported as something like
3.0_RC1-3-gc4349e3f: this simply indicates that you are running a more recent version than
3.0_RC1(in this example, 3 commits ahead, with latest git commit having SHA1 identifier