Skip to main content

Quick GUI viewer for .npy / .npz arrays with image, table, and cross-section views

Project description

npyquick logo

Why npyquick?

Researchers often need to quickly inspect .npy and .npz files without writing a notebook, launching an IDE, or remembering the array shape in advance.

npyquick is designed as a small, practical viewer for this job:

  • open NumPy array files directly from the terminal or file manager
  • inspect common scientific data layouts immediately
  • stay lightweight and easy to understand
  • avoid turning a simple array viewer into a full image-processing application

Installation

With pip:

pip install npyquick

With conda:

conda env create -f environment.yml
conda activate npyquick

Dependencies: Python ≥ 3.10, NumPy, SciPy, Matplotlib, and PySide6.

Usage

npyquick                        # open GUI
npyquick path/to/file.npy       # open with a file
npyquick path/to/file.npz       # open a multi-array archive

Files can be opened via File › Open (Ctrl+O) or by dragging and dropping onto the window.

Features

Image view

Preview 2D grayscale arrays and RGB arrays with interactive zoom, pan, colormap control, brightness adjustment, and a draggable cross-section profile.

Image view of an RGB array

Histogram view

Inspect value distributions with linear or log-scaled counts, robust range selection, summary statistics, and NaN / Inf reporting.

Histogram view

Line Plot view

Display 1D signals and paired (x, y) arrays with interactive zoom, pan, reset, and optional log-scaled axes.

Line plot view

Table view

Fallback preview for arrays that are not naturally displayed as images or line plots, including higher-dimensional, complex, object, scalar, or empty arrays.

Table view

.npz archives

When a .npz archive contains multiple arrays, npyquick shows a key selector with each array's name, shape, and dtype. Switching the selected key reloads the active view.

Open an .npz archive

For detailed display rules, normalization behavior, downsampling, and performance limits, see Display behavior.

Keyboard shortcuts

Shortcut Action
Ctrl+O Open file
Ctrl+S Export current figure
Ctrl+C Copy current figure
Ctrl+Q Quit
F5 / Ctrl+R Reload current file
Ctrl+Tab Switch to next enabled tab
Ctrl+Shift+Tab Switch to previous enabled tab

Linux desktop integration

Register npyquick as the handler for .npy / .npz files so you can double-click them in your file manager, or right-click → Open With:

npyquick --install-desktop

This installs a .desktop entry, the .npy / .npz MIME types, and the app icon under ~/.local/share (user-level, no root). Then double-click a file, or test from the terminal:

xdg-open path/to/file.npy

To remove it:

npyquick --uninstall-desktop

Works on desktops that follow the freedesktop.org desktop-entry and MIME standards (GNOME, KDE Plasma, XFCE, Cinnamon, MATE). Some environments only show the new association after the file manager restarts or you log out and back in.

Manual setup (without the CLI command)

Create ~/.local/share/applications/npyquick.desktop, replacing the Exec= path with the output of which npyquick:

[Desktop Entry]
Type=Application
Name=npyquick
Comment=Open NumPy array files
Exec=/path/to/npyquick %f
Icon=npyquick
Terminal=false
Categories=Science;Utility;
MimeType=application/x-npy;application/x-npz;
StartupNotify=true

Register the MIME types by creating ~/.local/share/mime/packages/npyquick.xml:

<?xml version="1.0" encoding="UTF-8"?>
<mime-info xmlns="http://www.freedesktop.org/standards/shared-mime-info">
  <mime-type type="application/x-npy">
    <comment>NumPy array file</comment>
    <glob pattern="*.npy" weight="100"/>
  </mime-type>
  <mime-type type="application/x-npz">
    <comment>NumPy compressed archive</comment>
    <sub-class-of type="application/zip"/>
    <glob pattern="*.npz" weight="100"/>
  </mime-type>
</mime-info>

The sub-class-of and high glob weight matter for .npz: it is a ZIP container internally, so without them some desktops classify it as application/zip before the extension rule applies.

Then update the databases and set the default handler:

update-mime-database ~/.local/share/mime
update-desktop-database ~/.local/share/applications
xdg-mime default npyquick.desktop application/x-npy
xdg-mime default npyquick.desktop application/x-npz

Roadmap

  • >2D array slicer
  • Complex array support: real / imaginary / magnitude / phase

Contributing

Bug reports, feature requests, and suggestions are welcome — please open an issue.

The code in this repository is primarily written by an AI coding agent and reviewed by a human maintainer.

License

Copyright 2026 LiukDiihMieu

This project is licensed under the GNU General Public License v3.0 or later. Project logo and visual assets are included for use with this project. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

npyquick-0.1.1.tar.gz (627.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

npyquick-0.1.1-py3-none-any.whl (58.5 kB view details)

Uploaded Python 3

File details

Details for the file npyquick-0.1.1.tar.gz.

File metadata

  • Download URL: npyquick-0.1.1.tar.gz
  • Upload date:
  • Size: 627.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for npyquick-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5a538632a899e570dadaa5b71ac494015fa8820ad5ba5804697fe3261c4c6649
MD5 d9fc8de6f1baa1c07605b67f8efd0a93
BLAKE2b-256 a65d75a28e8730904f1c786c2002024524b5a1cc84d3d8b14d0c214c6b91ec52

See more details on using hashes here.

File details

Details for the file npyquick-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: npyquick-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 58.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for npyquick-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dc9397c77f708b01f447f6d2dd4c151a99a1f3ed623fa59c19e1004d66718f81
MD5 19b85b12bd01c57fa89a1a77530871f2
BLAKE2b-256 c12412d6dca947ad2b289dd7bc6edf5a12192d1d931f5f25aaff7c64f0c3e5e4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page