https://github.com/glotzerlab/signac-dashboard

Rapidly visualize signac projects through a customizable dashboard interface.
https://github.com/glotzerlab/signac-dashboard

analysis dashboard data flask signac visualization

Last synced: 3 months ago
JSON representation

Rapidly visualize signac projects through a customizable dashboard interface.

• Host: GitHub
• URL: https://github.com/glotzerlab/signac-dashboard
• Owner: glotzerlab
• License: bsd-3-clause
• Created: 2019-01-30T22:34:07.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2026-02-26T07:28:58.000Z (3 months ago)
• Last Synced: 2026-02-26T12:42:04.483Z (3 months ago)
• Topics: analysis, dashboard, data, flask, signac, visualization
• Language: Python
• Homepage: https://signac.readthedocs.io/
• Size: 3.1 MB
• Stars: 16
• Watchers: 8
• Forks: 6
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.txt
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
#  signac-dashboard - data visualization for signac

[![Affiliated with NumFOCUS](https://img.shields.io/badge/NumFOCUS-affiliated%20project-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org/sponsored-projects/affiliated-projects)

[![PyPI](https://img.shields.io/pypi/v/signac-dashboard.svg)](https://pypi.org/project/signac-dashboard/)

[![conda-forge](https://img.shields.io/conda/vn/conda-forge/signac-dashboard.svg?style=flat)](https://anaconda.org/conda-forge/signac-dashboard)

[![RTD](https://img.shields.io/readthedocs/signac-dashboard.svg?style=flat)](https://signac.readthedocs.io/)

[![License](https://img.shields.io/github/license/glotzerlab/signac-dashboard.svg)](https://github.com/glotzerlab/signac-dashboard/blob/main/LICENSE.txt)

[![PyPI-downloads](https://img.shields.io/pypi/dm/signac-dashboard.svg?style=flat)](https://pypistats.org/packages/signac-dashboard)

[![Twitter](https://img.shields.io/twitter/follow/signacdata?style=social)](https://twitter.com/signacdata)

[![GitHub Stars](https://img.shields.io/github/stars/glotzerlab/signac-dashboard?style=social)](https://github.com/glotzerlab/signac-dashboard/)

The [**signac** framework](https://signac.readthedocs.io) 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](https://signac.readthedocs.io/en/latest/dashboard.html):

  Introduction to **signac-dashboard**.

- [Dashboard documentation](https://signac.readthedocs.io/projects/dashboard/):

  Package reference and APIs.

- [Dashboard examples](examples/):

  Example dashboards demonstrating a variety of use cases.

- [Framework documentation](https://signac.readthedocs.io/):

  Examples, tutorials, topic guides, and package Python APIs.

## 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](https://conda-forge.github.io/) channel, execute:

```bash

conda install -c conda-forge signac-dashboard

```

To install **signac-dashboard** *via* **pip**, execute:

```bash

pip install signac-dashboard

```

**Detailed information about alternative installation methods can be found in the [documentation](https://signac.readthedocs.io/projects/dashboard/en/latest/installation.html).**

## Quickstart

In an existing **signac** project directory, create a file `dashboard.py`:

```python

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:

```bash

$ python dashboard.py run

```