API

The complete signac-dashboard application interface (API).

Command Line Interface

Some core signac-dashboard functions are – in addition to the Python interface – accessible directly via the $ signac-dashboard command.

For more information, please see $ signac-dashboard --help.

Module contents

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)

class signac_dashboard.Module(name, context, template, enabled=True)

Bases: object

disable()

enable()

get_cards()

register_assets(dashboard)

register_routes(dashboard)

toggle()