Metadata-Version: 2.1
Name: niftiview-app
Version: 1.0.2
Summary: Standalone app for viewing volumetric images 🧠 based on Python
Home-page: https://github.com/codingfisch/niftiview-app
License: MIT
Author: codingfisch
Author-email: l_fisc17@wwu.de
Requires-Python: >=3.9,<4.0
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: dcm2niix
Requires-Dist: niftiview (>=1.0.0)
Requires-Dist: sv-ttk
Requires-Dist: tkinterdnd2 ; sys_platform != "darwin"
Requires-Dist: tkinterdnd2-universal ; sys_platform == "darwin"
Project-URL: Repository, https://github.com/codingfisch/niftiview-app
Description-Content-Type: text/markdown

![niftiview_logo_transparent_small](https://github.com/user-attachments/assets/109d0dda-6704-4d9c-9c14-4b29aaa1a52f)

NiftiView is a medical 3D image viewer **made for amateurs** 👨, **clinicians** 👩‍⚕️, **scientists** 👨‍🔬 and **coders** 👩‍💻

**Highlight features** for each user group are

- 👨 **Drag&Drop** to easily **view multiple** 3D images in a **beautiful layout** and save as a **GIF**
- 👩‍⚕️ **Shortcuts** to quickly set up **optimal contrasts** by intensity windowing and **histogram equalization**
- 👨‍🔬 **Custom image layers and overlays** (crosshair, colorbar...) to create **publication-ready figures**
- 👩‍💻 Usable via **Python and Command Line Interface** (take a look at [the underlying Python package](https://github.com/codingfisch/niftiview))

![niftiview](https://github.com/user-attachments/assets/facd5b06-5438-4c50-8ad0-d3e928c9f258)

Besides these highlights, NiftiView also **covers the basics**
- 💾 Supports **NIfTI** `.nii`/`.nii.gz`, **NumPy** `.npy`, **DICOM** and some **older 3D image formats**
- 🖼️ **High image quality** via Lanczos interpolation
- 📥 **Easy installation** for Windows and Linux: [**Download**](https://github.com/codingfisch/niftiview-app/releases), unzip, double-click 🏁

Learn how to use NiftiView via [the **YouTube-Tutorial**](https://youtu.be/OVUy_wd98Ps) 💡

## Installation 🛠️
### Windows 🪟 or Linux 🐧
Download the app [**here**](https://github.com/codingfisch/niftiview-app/releases), unzip the downloaded file and double-click either
- NiftiView.exe (+ ignore potential virus alert, if you are using Windows)
- NiftiView.bin (+ previously run `chmod +x NiftiView.bin` in a terminal, if you are using Linux) 

to run NiftiView 🧠 If you like it, check out [this short manual](https://github.com/codingfisch/niftiview-app/blob/main/install.md) to finalize the installation 🛠️
### The Python way 🐍
Users of macOS 🍏 and/or [Pythonistas](https://en.wiktionary.org/wiki/Pythonista) just **install it in the terminal** via
```bash
pip install niftiview-app
```
and **run it** via
```bash
niftiview-app
```
Some extra steps to make NiftiView feel like a macOS app are provided [here](https://github.com/codingfisch/niftiview-app/blob/main/install.md) 🛠️

### Bugfixes 🐛
- If the app does not start, missing packages can be the issue. To fix that:
  - On Linux: Run `sudo apt install libcairo2-dev pkg-config python3-dev`
  - On macOS: Run `brew install cairo pkg-config tcl-tk python-tk`
- If the app [looks grainy](https://github.com/ContinuumIO/anaconda-issues/issues/6833) in a conda env, run `conda install -c conda-forge tk=*=xft_*` to fix it

