Signac-dashboard package documentation¶

Note

This is documentation for the signac-dashboard package, which is part of the signac framework. See here for a comprehensive introduction to the signac framework.

Contents¶

Installation¶

The recommended installation method for signac-dashboard is via conda or pip. The software is tested for Python versions 3.6+. Its primary dependencies are signac and flask.

Install with conda¶

You can install signac-dashboard via conda (available on the conda-forge channel), with:

$ conda install -c conda-forge signac-dashboard

All additional dependencies will be installed automatically. To upgrade the package, execute:

$ conda update signac-dashboard

Install with pip¶

To install the package with the package manager pip, execute

$ pip install signac-dashboard --user

Note

It is highly recommended to install the package into the user space and not as superuser!

To upgrade the package, simply execute the same command with the --upgrade option.

$ pip install signac-dashboard --user --upgrade

Source Code Installation¶

Alternatively you can clone the git repository and execute the setup.py script to install the package.

git clone https://bitbucket.org/glotzer/signac-dashboard.git
cd signac-dashboard
git submodule update --init  # This step is required!
python setup.py install --user

API Reference¶

This is the API for the signac-dashboard application.

Dashboard¶

class signac_dashboard.Dashboard(config={}, project=None, modules=[])[source]¶

Bases: object

create_app(config={})[source]¶

create_assets()[source]¶

classmethod decode_modules(json_modules, enabled_modules=None)[source]¶

classmethod encode_modules(modules, target='dict')[source]¶

encoded_modules¶

get_all_jobs[source]¶

get_job_details(jobs)[source]¶

job_search[source]¶

job_sorter(job)[source]¶

job_subtitle(job)[source]¶

job_title(job)[source]¶

main()[source]¶: Call this function to use the dashboard command line interface.

prepare()[source]¶

register_module_asset(asset)[source]¶

register_routes()[source]¶

run(host='localhost', port=8888, *args, **kwargs)[source]¶

url(import_name, url_rules=[], import_file='signac_dashboard', **options)[source]¶

Modules¶

class signac_dashboard.modules.ImageViewer(name='Image Viewer', context='JobContext', template='cards/image_viewer.html', img_globs=['*.png', '*.jpg', '*.gif'], **kwargs)[source]¶