Commit 701259c7 authored by ihuszar's avatar ihuszar
Browse files

Merge branch 'res_mgr' of git.fmrib.ox.ac.uk:ihuszar/tirl into res_mgr

Updated Readme file for GitLab.
parents d5a22cf0 58a87b41
......@@ -8,7 +8,7 @@ Tensor Image Registration Library
```
mkdir -p ~/Applications/
cd ~/Applications
git clone https://github.com/inhuszar/tirl.git
git clone https://git.fmrib.ox.ac.uk/ihuszar/tirl.git
```
2. Create virtual environment for registration projects with TIRL.
......@@ -29,4 +29,29 @@ conda activate regenv
cd ~/Applications/tirl
python setup.py install
```
```
## Configuration
Note: to configure TIRL, you must be within the Python environment where you
installed TIRL ('regenv' in the above example).
To configure TIRL for your system, type ```tirlconfig``` in your terminal
window. This will allow you to edit the configuration parameters using vim.
To use another editor, e.g. nano, type ```tirlconfig nano```. Other options
might include subl (Sublime Text), atom (Atom), or emacs (Emacs), depending on
what is available on your system.
## Basic test
1. Open the python shell by typing ```python``` in the terminal window (make sure
that you have previously activated the 'regenv' environment).
2. Type the following in the interactive shell:
```
from tirl.timage import TImage
img = tirl.testimg()
img.preview()
```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment