Visualize data spaces in a web browser.
Project description
signac-dashboard - data visualization for signac
The signac framework helps users manage and scale file-based workflows, facilitating data reuse, sharing, and reproducibility.
The signac-dashboard package allows users to rapidly visualize and analyze data from a signac project in a web browser.
Resources
- Dashboard topic guide: Introduction to signac-dashboard.
- Dashboard documentation: Package reference and APIs.
- Dashboard examples: Example dashboards demonstrating a variety of use cases.
- Framework documentation: Examples, tutorials, topic guides, and package Python APIs.
- Slack Chat Support: Get help and ask questions on the signac Slack workspace.
- signac website: Framework overview and news.
Installation
The recommended installation method for signac-dashboard is through conda or pip. The software is tested for Python 3.8+ and is built for all major platforms.
To install signac-dashboard via the conda-forge channel, execute:
conda install -c conda-forge signac-dashboard
To install signac-dashboard via pip, execute:
pip install signac-dashboard
Detailed information about alternative installation methods can be found in the documentation.
Quickstart
In an existing signac project directory, create a file dashboard.py:
from signac_dashboard import Dashboard
from signac_dashboard.modules import StatepointList, DocumentList, ImageViewer, Schema
if __name__ == '__main__':
modules = [StatepointList(), DocumentList(), ImageViewer(context="JobContext"),
ImageViewer(context="ProjectContext"), Schema()]
Dashboard(modules=modules).main()
Then launch the dashboard:
$ python dashboard.py run
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file signac-dashboard-0.6.1.tar.gz.
File metadata
- Download URL: signac-dashboard-0.6.1.tar.gz
- Upload date:
- Size: 1.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ea0f9f3e3016ea4d247f33575ae5c98b87d08e4503f2c239a4f10ab7a888482e |
|
| MD5 | 78b1b19dffb0ef4ce977d5d89feafb89 |
|
| BLAKE2b-256 | 8696f9be2865e8b4a66ce8fa6948d53cd41035a2a343af6a205b6e67d045c814 |
Provenance
File details
Details for the file signac_dashboard-0.6.1-py3-none-any.whl.
File metadata
- Download URL: signac_dashboard-0.6.1-py3-none-any.whl
- Upload date:
- Size: 1.2 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 72bf6d5989470b835d79220a0e868415fc22d38455d2f649f7edbcb60410a6c9 |
|
| MD5 | 412c7965b752e8e950793550dad42520 |
|
| BLAKE2b-256 | 12755b8dbd0a0a82d039066816fe8a3891e60d79aa4cab5afbb0b436f8c9afcc |
