JLD2View.jl/README.md

JLD2View.jl

Electron-based data viewer for JLD2 files.

Programmatic usage

In a julia session:

julia> using JLD2View

julia> jld2_view("path/to/file.jld2")

Command-line

Depending on your workflow, using JLD2View from the command-line might be more convenient. It can also more easily benefit from the use of a custom system image to reduce latency.

First, install the JLD2View command-line interface:

julia> import JLD2View

help?> JLD2View.install
  JLD2View.install(; kwargs...)

  Install the command-line interface.
  
  Keyword arguments:
    - `command`: name of the executable command, defaults to `jld2view`.
    - `destdir`: writable directory (available in PATH) for the executable, defaults to `~/.julia/bin`.
    - `julia`: path to the julia executable, defaults to the path of the currently running julia.
    - `julia_flags`: vector of command-line flags for the julia executable, defaults to `$JULIA_FLAGS_DEFAULT`.
    - `force`: boolean used to allow overwriting existing commands, defaults to `false`.
    - `compile`: boolean to enable the compilation of a custom system image, defaults to `true`.

julia> JLD2View.install()
# [...]
┌ Info: Installing the JLD2View command-line interface
│   launcher = "~/.julia/bin/jld2view"
│   julia = "/path/to/julia/1.7.2/bin/julia"
│   flags = "--startup-file=no --quiet --sysimage=~/.julia/scratchspaces/a494b24a-6d3b-4871-b66b-22839c4c06d4/sysimages/sysimage.so"
└   projectdir = "/path/to/JLD2View/"

Make sure that destdir (~/.julia/bin by default) is in your PATH. Then, you can use JLD2View from the command-line

shell$ jld2view path/to/file.jld2

or, simply

shell$ jld2view

In this last case, you’ll be prompted to pick a JLD2 file interactively.