figpack 0.2.4

A Python package for creating shareable, interactive visualizations in the browser

figpack

A Python package for creating shareable, interactive visualizations in the browser.

Overview

figpack enables you to create interactive data visualizations that can be displayed in a web browser and optionally shared online. The package focuses on timeseries data visualization with support for complex, nested layouts.

Key Features

• Interactive timeseries graphs with line series, markers, and interval plots
• Flexible layout system with boxes, splitters, and tab layouts
• Web-based rendering that works in any modern browser
• Shareable visualizations that can be uploaded and shared via URLs
• Zarr-based data storage for efficient handling of large datasets

Installation

Install figpack using pip:

pip install figpack

Quick Start

import numpy as np
import figpack.views as vv

# Create a timeseries graph
graph = vv.TimeseriesGraph(y_label="Signal")

# Add some data
t = np.linspace(0, 10, 1000)
y = np.sin(2 * np.pi * t)
graph.add_line_series(name="sine wave", t=t, y=y, color="blue")

# Display the visualization
graph.show(open_in_browser=True, title="Quick Start Example")

Available Views

figpack provides a comprehensive set of view components for creating interactive visualizations:

Core Views

• TimeseriesGraph - Interactive line plots, markers, and intervals (example)
• MultiChannelTimeseries - Multi-channel timeseries visualization (example)
• Image - Display images with optional annotations (example)
• Markdown - Render markdown content (example)

Layout Views

• Box - Flexible container with horizontal/vertical layouts (example)
• Splitter - Resizable split panes (example)
• TabLayout - Tabbed interface for multiple views (example)

External Figure Support

• MatplotlibFigure - Embed matplotlib plots (example)
• PlotlyFigure - Embed plotly visualizations (example)

Spike Sorting Views

• Autocorrelograms - Auto-correlation analysis (example)
• CrossCorrelograms - Cross-correlation analysis (example)
• UnitsTable - Sortable table for spike sorting units (example)

Examples

See the examples/ directory for working examples of each view type.

Usage Modes

Local-only Mode

view.show(open_in_browser=True, title="Local Visualization")

Sharing Online

Set the FIGPACK_API_KEY environment variable and use:

view.show(upload=True, open_in_browser=True, title="Shared Visualization")

Development Mode

Set _dev=True in the call to show() to enable development mode, which allows for live updates and development of figpack-gui.

Command Line Interface

figpack includes a command-line interface for working with figures:

Download a Figure

figpack download <figure-url> <dest.tar.gz>

Download a figure from any figpack URL and save it as a local archive.

View a Figure Archive

figpack view <figure.tar.gz>

Extract and view a figure archive in your browser. The server will run locally until you press Enter.

Use --port <number> to specify a custom port.

License

Apache-2.0

Contributing

Visit the GitHub repository for issues, contributions, and the latest updates.