Metadata-Version: 2.1
Name: niicat
Version: 0.2
Summary: Preview nifti images on the terminal
Home-page: https://github.com/wasserth/niicat/
Author: Jakob Wasserthal
Author-email: j.wasserthal@dkfz.de
License: GPL v2
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Requires-Python: >=2.7
Description-Content-Type: text/markdown
Requires-Dist: nibabel (>=2.3.0)
Requires-Dist: matplotlib
Requires-Dist: numpy

# niicat

This is a tool to quickly preview nifti images on the terminal. 
This can be helpful if you are working on a remote server via SSH and do not have
a -X connection. Per default it uses [libsixel](https://github.com/saitoha/libsixel) to display the images.
If you add the option `-ic` it will use [iTerm2's](https://www.iterm2.com/) `imgcat` command instead of libsixel 
to display the images.


### Install:

```
pip install niicat
```


### Install prerequisite libsixel (if you do not use iterm2):
Ubuntu
```
sudo apt install libsixel-bin
```

Mac (build from source)
```
git clone https://github.com/saitoha/libsixel.git
cd libsixel
./configure
make
make install
```

Also check out the [terminal requirements](https://github.com/saitoha/libsixel#terminal-requirements) for 
libsixel to work.


### Usage:

```
niicat T1.nii.gz
```

![](niicat/resources/example.gif)


### This code is based on the following code:

[niipre](https://github.com/vnckppl/niipre)  
[imgcat](https://www.iterm2.com/utilities/imgcat)


