API Reference

This is the API for the signac-dashboard application.

Dashboard

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

Bases: object

create_app(config={})

create_assets()

classmethod decode_modules(json_modules, enabled_modules=None)

classmethod encode_modules(modules, target='dict')

encoded_modules

get_all_jobs

get_job_details(jobs)

job_search

job_sorter(job)

job_subtitle(job)

job_title(job)

main()

Call this function to use the dashboard command line interface.

prepare()

register_module_asset(asset)

register_routes()

run(host='localhost', port=8888, *args, **kwargs)

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

Modules

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

Bases: signac_dashboard.module.Module

get_cards(job)

class signac_dashboard.modules.VideoViewer(name='Video Viewer', context='JobContext', template='cards/video_viewer.html', video_globs=['*.mp4', '*.m4v'], preload='none', poster=None, **kwargs)

Bases: signac_dashboard.module.Module

get_cards(job)

class signac_dashboard.modules.StatepointList(name='Statepoint Parameters', context='JobContext', template='cards/statepoint_list.html', **kwargs)

Bases: signac_dashboard.module.Module

get_cards(job)

class signac_dashboard.modules.DocumentList(name='Job Document', context='JobContext', template='cards/document_list.html', max_chars=None, **kwargs)

Bases: signac_dashboard.module.Module

get_cards(job)

class signac_dashboard.modules.FileList(name='File List', context='JobContext', template='cards/file_list.html', prefix_jobid=True, **kwargs)

Bases: signac_dashboard.module.Module

download_name(job, filename)

get_cards(job)

class signac_dashboard.modules.Notes(name='Notes', context='JobContext', template='cards/notes.html', **kwargs)

Bases: signac_dashboard.module.Module

get_cards(job)

register_assets(dashboard)

register_routes(dashboard)