Feature description

When looking at files with the FileList module, it might be nice to have a "preview" page that works kind of like GitHub's previews for text (and potentially binary) files.

Proposed solution

Create a new view that includes a download button and does syntax highlighting with pygments. The current FileList buttons could link to this preview instead of direct download.

Feature description

It would be great if there was a text box into which I could enter the first few characters of a statepoint id and go directly to that job. I can currently go to localhost:port/jobs/abc123, but it would be nicer if I didn't have to click in the address bar to do that.

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

In compact mode (only one module selected), the pagination is still divided by the job number, not by the actual number of cards to show per page.
This makes it awkward to navigate large data spaces, where only a few jobs have cards available.

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

The dashboard should detect the schema and present a job title based on the variables within the schema.

I suggest the following format for job title / subtitle:

"a=42 b='foo' c.bar='baz'" -- <job_id>

Users including @swerdfish and @berceanu have requested Bokeh interactive plots. This feature would be a great addition to signac-dashboard.

This page about embedding Bokeh plots should provide the info needed to add such a feature. Additionally, this pull request shows an example of what it takes to add a new JavaScript-enabled module to the dashboard.

Feature description

In my experience, new users sometimes find the following confusing: after clicking on one job in the dashboard, they expect that clicking the List View / Grid View buttons in the top-left navbar would take them back to the list of all jobs. However, that only happens when one clicks on Jobs in the corner, and it is not apparent that is a clickable button.

Proposed solution

Perhaps the Jobs button can be made more apparent, or if not, the List View / Grid View could take one back to the initial list showing all jobs?

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

The dashboard documentation needs to explain how to use custom template paths.

An example dashboard with a minimal custom module should also be added.

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

Docs should point to pip and conda for installation, instead installing from the git repo.

1. signac-dashboard/signac_dashboard/modules/video_viewer.py

   Line 19 in 79ebe36

   poster=None,

   should probably be poster='none', otherwise we get a TypeError: join() argument must be str or bytes, not 'NoneType' on

   signac-dashboard/signac_dashboard/modules/video_viewer.py

   Line 39 in 79ebe36

   poster=self.poster if self.poster and job.isfile(

2. The dictionary returned by make_card should also contain the key jobid=job._id, otherwise the path to the video files is incorrect: http://localhost:<port>/jobs//file/<fname>.mp4 (notice missing job hash).

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

The shut-down via KeyboardInterrupt sometimes fails for no apparent reason.
Repeated interrupts will eventually shut down the server.

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

I think it would be great if the menu on the left would stay on left so that it is not necessary to scroll all the way up for the module selection.

Feature description

It would be nice if the navbar showing the module list would be visible when browsing from a small-screen mobile device.

Proposed solution

Perhaps it could be toggled on/off for saving screen real-estate?

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

Users should be able to "tag" jobs, i.e. for further review. Tag names and colors should be stored in the project document. Each job will have a set of its tags in the job document.

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

Modules should be able to render into Jupyter notebooks. An example should be created for module development and usage inside Jupyter notebooks. Idea provided by @klarh.

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

The current module structure only has one type of module. Splitting this into "core" and "contrib" would allow for modules in "contrib" that may have additional requirements but fit into common workflows.

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

The signac-dashboard should be deployed through pypi, so that it can be installed with

#!bash
pip install signac-dashboard

Feature description

It would be dope if searches were saved and easily accessible from the dashboard. I find myself entering fairly complicated search strings and then needing to reuse the searches.

Proposed solution

Having a search history in the dashboard page would be nice, and being able to somehow label searches would be a further enhancement.

Additional context

I'm happy to try to implement this kind of feature but I really have no idea where to start.

Feature description

It would be nice to have something analogous to flow init, as a starting point for modifying things. e.g. I wanted to just change the titles, but then running python dashboard.py meant that I no longer had the default modules showing. It'd be much easier to have the default settings generated with an init call that users can then build on.

Proposed solution

signac-dasboard init that generates a dashboard.py script with all the default modules

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

Make a "contrib" module that uses the fresnel renderer to visualize frames / animations from common Glotzer group file formats.

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

Pointing the python path to the source directory in order to run the dashboard without installation causes a sass.CompileError unless the user executes git submodule update --init before starting the dashboard.

It might be nice to trigger the submodule update when executing either python setup.py build or python setup.py develop to avoid confusion.

I think it would be great if it was possible to open images in the ImageViewer either in the same tab or a new tab by clicking on them.

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

Create one or more module(s) with "JobGroup" as their context, which take an iterable of jobs as an argument and return cards. i.e. matplotlib plots or averaging a field in job.document.

Original report by Jens Glaser (Bitbucket: jens_glaser, GitHub: jglaser).

I have to manually call the prepare() method:

#!/usr/bin/env python3
from signac_dashboard import Dashboard
from signac_dashboard.modules import ImageViewer


if __name__ == '__main__':
    dashboard = Dashboard(modules=[ImageViewer()])
    dashboard.prepare()
    dashboard.run(host='localhost', port=8888)

I believe that should be unnecessary

In order to share analysis results with my team members, I would find it useful to be able to host signac dashboards on an nginx/apache web server instance hosting our domain. Is that possible/documented?

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

Following the model of signac and signac-flow, create similar documentation to be hosted on ReadTheDocs.

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

The dashboard menu should include a project overview page. Information I'd like to include:

• Project Schema
• Project document
• Project directory path
• Number of jobs

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

Re-write the notes module with better JavaScript. It should be more modular than it is currently.

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

Trying to launch a dashboard results in the following error:

$ ./dashboard/dashboard.py
Adding '.' to dashboard paths.
Traceback (most recent call last):
  File "./dashboard/dashboard.py", line 56, in <module>
    config=config
  File "/home/csadorf/.local/lib/python3.6/site-packages/signac_dashboard/dashboard.py", line 36, in __init__
    cache.init_app(self.app)
  File "/home/csadorf/.local/lib/python3.6/site-packages/Flask_Cache-0.13.1-py3.6.egg/flask_cache/__init__.py", line 156, in init_app
    from .jinja2ext import CacheExtension, JINJA_CACHE_ATTR_NAME
  File "/home/csadorf/.local/lib/python3.6/site-packages/Flask_Cache-0.13.1-py3.6.egg/flask_cache/jinja2ext.py", line 33, in <module>
    from flask.ext.cache import make_template_fragment_key
ModuleNotFoundError: No module named 'flask.ext'

This happens with fresh installs with either pip, conda, or local install.

Feature description

Dashboard should be able to display pdfs or vector graphics formats.

Additional context

@tcmoore3 was outputting project level phase diagrams as pdfs

Description

When attempting to add multiple instances of the Notes module to a dashboard, only the first one (passed to the modules argument of PlotDashboard) actually appears on the dashboard.

To reproduce

from signac_dashboard import Dashboard
from signac_dashboard.modules import StatepointList, ImageViewer, VideoViewer
from signac_dashboard.modules import Notes, DocumentEditor

class PlotDashboard(Dashboard):
    def job_sorter(self, job):
        return job.sp.get('x', 0)


if __name__ == '__main__':
    modules = []
    notes_mod = Notes(name='notes 1', key='notes1')
    modules.append(notes_mod)
    other_notes_mod = Notes(name='notes 2', key='notes2')
    modules.append(other_notes_mod)
    PlotDashboard(modules=modules).main()

System configuration

$ python -c 'import platform; print(platform.platform()); import sys; print(sys.version); import signac_dashboard; print(signac_dashboard.__version__)'
Darwin-17.7.0-x86_64-i386-64bit
3.6.7 | packaged by conda-forge | (default, Jul  2 2019, 02:07:37) 
[GCC 4.2.1 Compatible Clang 4.0.1 (tags/RELEASE_401/final)]
0.2.5

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

Every job on a list/grid view should have an anchor tag, and basic keyboard shortcuts should be available, roughly mirroring vim and/or Gmail, for scrolling through jobs, tagging jobs, opening jobs in a new tab, and navigating pages.

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

Directly opening a job by url (../jobs/abcdef...) results in a 500 server error if a job with given id is not in the project.

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

Create a module to call matplotlib and render HOOMD-style log outputs, e.g. "energy vs. time."

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

Summary

With standard browser settings, images are locally cached, which means users might accidentally see outdated versions of plots etc.. unless they do a "deep refresh".

It might be a good idea to instruct the browser to not cache these images, or only for a very short time.
This could possibly be a module option, but default behavior should be no caching.

Observed Behavior

Hitting a simple refresh shows outdated images.

Expected Behavior

Hitting a simple refresh should always show the current version of each image.

Feature description

It would be nice to have a button to copy the text in a TextDisplay box, instead of having to select the text and click copy or ctrl-c. Something similar to how you can copy the git repo url to make it easy to clone a repo from github.

Proposed solution

I'm not sure how to implement this feature, but I'm guessing there's some simple html thing to make it work given the ubiquity of this feature throughout the internet.

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

It would be great if it was possible to specify which modules are toggled on by default when first launching the dashboard.

I am not sure about the best API for this, but one way might be a class attribute of the Dashboard class.

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

When I play videos in the VideoViewer module, and try to seek back and forth, it refuses to work and just keeps playing from where it was before. This is probably due to Chrome sending a request for 206 Partial Content. Firefox does fine, probably because it's caching the entire video.

More info:
https://stackoverflow.com/questions/8088364/html5-video-will-not-loop

The dashboard server needs to support partial content responses for file requests, especially for the case of larger/longer videos.

Feature description

It would be nice if there was an option to hide the statepoint parameters that are constant across all jobs in the Statepoint Parameters card. This would be especially useful in the exploration stages of a project when you add sp params that you think may change but have only initialized a subset of all possible jobs.

Proposed solution

I'm not sure how all of this works on the back end, but it's just loading a signac project somewhere, so there should be a way to call project.detect_schema(exclude_const=True) and pass that information along to wherever it needs to go.

Feature description

ImageViewer(name="One plot", img_globs=["my_amazing_plot.png"]),
ImageViewer(name="All Plots"),

It would be nice if "my_amazing_plot.png" would not appear twice on the dashboard page.

Proposed solution

Perhaps one one module is activated, it could check the output from the other modules and eliminate the duplicates?

Currently, Bitbucket Pipelines generate releases for new tags pushed to the repository. I need to update the CircleCI configuration to perform this release, now that we use GitHub.

I know I can search inside a dashboard, but can I select a subset of jobs to be shown by default in a particular project dashbard, based on a statepoint/doc filter?

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

The package should provide an executable dashboard that runs the dashboard file specified in the project configuration, and creates a default dashboard.py in the project directory if one does not exist.

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

In grid view, when multiple modules are selected, jobs are shown, even if they don't have any cards to show.

This only happens in multi module mode, not if only one module is selected.

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

The search bar can currently be used for standard search and document search with (doc:), but not both in combination.

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

If not provided in the dashboard script, modules and config should be read from the project document.

A JSON file import/export should be available through the executable (#20).

Settings changed by the user should be kept in the user session, and written to the project document with a "save" feature.

Original report by Bradley Dice (Bitbucket: bdice, GitHub: bdice).

Currently if you do a search that returns no results, it says:

No jobs found for the provided query.
Pagination Error. Displaying page 0.

The pagination error should be suppressed if there are no jobs to show.

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

The signac-dashboard has currently the following depedencies:

• flask
• jsmin
• flask-assets
• flask-cache
• libsass
• cssmin
• flask-turbolinks

All dependencies available on conda-forge!

Long file names as part of the ImageViewer module (but I assume that applies to similar modules as well), are partially hidden, wheras they should probably be either broken or just cut of with some kind of placeholder such as ....

I assume changes would need to be made here (?):

Add Gallery of "Rendered" Dashboard Examples

Original report by Carl Simon Adorf (Bitbucket: csadorf, GitHub: csadorf).

The README should feature a screenshot / screencast.

For example, something like this: