Skip to main content

A tool to perform n-dimensional plots from a collection of figures.

Project description

N-dimensional plotting: ndplot

BuyMeACoffee GitHub Release Date GitHub release (latest by date) GitHub all releases PyPI - Downloads License: GPL v3

showcase_gif

This post-processing tool generates an n-dimensional plot from a given colletion of figures. There are many other tools out there that perform the very same task (e.g. napari, paraview, visit), but they all have very steep learning curves. On the other hand, ndplot is designed to be extremely easy to use, simply run

ndplot -d /dir/with/the/figures/to/plot

with figures names that must respect the following format

<optional_prefix><par1>=<val1>_<par2>=<val2>_...<parN>=<valN>.[png|jpg|gif]

For example

/dir/with/the/figures/to/plot
x0=0.0_y0=0.0_a0=0.3_b0=1.0.png
x0=0.0_y0=0.0_a0=0.3_b0=2.0.png
x0=0.0_y0=0.0_a0=0.3_b0=3.0.png
...

Also, running the tool with no flags will scan the current directory. That's it!

Finally, to navigate through the parameter space simply click on the sliders directly, or select a parameter with the numpad and scroll using the mouse wheel.

Installation

You can install ndplot from the official PyPi repository using pip

pip install ndplot

Equivalently, you can download the most recent release from here and install it manually.

Features and performaces

The command line tool provides the following flags:

  • -h prints a help dialogue;
  • -v prints the currently installed version;
  • -d input directory where the figure to be loaded are stored (optional).

Also, this tool uses a few optimizations to plot and display the graphs interactively:

  • figures are "lazy loaded", i.e. the system only reads a figure when it has to be displayed. In this way, ndplot can handle folder with thousand of plots without lagging.
  • most recent figures are cached, so to further reduce I/O usage.
  • parameters do not need to be equally spaced or to cover the whole parameter manifold. ndplot handles empty domains of the parameter space by simply falling back to the previously shown figure.

Support

I developed this tool in my spare time as I needed something to quickly plot really many figures. If you also find it usefull please consider BuyMeACoffee

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

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

ndplot-1.0.5.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

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

ndplot-1.0.5-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

Details for the file ndplot-1.0.5.tar.gz.

File metadata

  • Download URL: ndplot-1.0.5.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for ndplot-1.0.5.tar.gz
Algorithm Hash digest
SHA256 739e7232a407af2d5bf5f4f614c1dea2b11a48482e1eb6755ca9cbd8b0a8eb09
MD5 49c976a1bf7a22c69f13b9c6fea87687
BLAKE2b-256 563792cd33521f2a00703cc31b1f87dd0722fd6e09e6ba9ad853712aa29ff950

See more details on using hashes here.

File details

Details for the file ndplot-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: ndplot-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 18.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for ndplot-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 420fe6447f0384c68a9a1f0696d4a34975f23565db7677c7d9dec10e059b72c5
MD5 a3548e8c1173c71527a0b8b5974b8d2f
BLAKE2b-256 34a079d8f1afeed3211a0c3e7d221267ef5503064ec75b35cf6701d5374fbdbb

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