Skip to content
Rapidly visualize signac projects through a customizable dashboard interface.
Python HTML JavaScript CSS Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github Add GitHub templates. May 9, 2019
doc
examples
signac_dashboard
tests
.bumpversion.cfg
.deploy.bash Add submodules before building wheel. Oct 10, 2018
.gitignore
.gitmodules
.test-deploy.bash
CODE_OF_CONDUCT.md
CONTRIBUTING.md
ContributorAgreement.md
LICENSE.txt Update copyright. Apr 22, 2019
MANIFEST.in Prune extra files from wheel. Apr 10, 2018
README.md
changelog.txt
contributors.txt
setup.cfg
setup.py

README.md

signac-dashboard: data visualization for signac

PyPI conda-forge CircleCI RTD License PyPI-downloads Gitter

Built on top of the signac framework, signac-dashboard allows users to rapidly visualize and analyze data managed in a signac project.

Resources

Installation

The recommended installation method for signac-dashboard is through conda or pip. The software is tested for Python 3.5+ 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

if __name__ == '__main__':
    modules = [StatepointList(), DocumentList(), ImageViewer()]
    Dashboard(modules=modules).main()

Then launch the dashboard:

$ python dashboard.py run
You can’t perform that action at this time.