add hover-over descriptions

choderalab / fah-xchem

Tools and infrastructure for automated compound discovery using Folding@home

MIT License

6 stars 3 forks source link

add hover-over descriptions #115

Closed glass-w closed 3 years ago

glass-w commented 3 years ago

Description

Addresses #105.

Todos

This PR adds hover-over "info" icons to columns in the Sprint dashboard using popovers.

[x] Add hover-overs to "transformations" page
[ ] Test formatting locally (related to #106)

Questions

[ ] Add hover-overs to "summary" page (?)
[ ] Add hover-overs to "compounds" page (?)
[ ] Add hover-overs to "microstates" page (?)

Status

[ ] Ready to go

glass-w commented 3 years ago

Currently, in order to view the changes in index.html these lines need to be added at the top of the file (I am removing these when adding commits).

I don't think they are needed for the final rendering of the page on the dashbaord. It looks like in the current dashboard the styles are carried forward, but I can't guarentee this.

@mcwitt do you have any ideas here? I'm tempted to just add the above lines to index.html to ensure the hover-overs work as intended.

glass-w commented 3 years ago

Quick preview of how the hover-over feature looks:

mcwitt commented 3 years ago

@glass-w updates look awesome!

It looks like in the current dashboard the styles are carried forward

That's right---what you've done (adding the function to base.html) is how I'd do it too. This way it will be included in all templates that extend base.html (which should be all of them) without having to repeat yourself.

It works like this: to generate the final html for e.g. transformations/index.html, the content in the template gets inserted into base.html here. This happens because of the extends declaration in transformations/index.html here.

mcwitt commented 3 years ago

@glass-w in case it's useful, I used the following to debug the site generation on my laptop. This requires that you have the analysis results in results/analysis.json.

fah-xchem generate-artifacts results/analysis.json --fah-projects-dir "" --fah-data-dir "" --base-url "/" --noplots --nosnapshots --output-dir results --num-procs 8 --log INFO && python -m http.server --directory results

Then you can point your browser to http://0.0.0.0:8000/ to see the result. You can also omit --noplots on the first run to generate plots in results/ (but this takes some time).

glass-w commented 3 years ago

@mcwitt Great! Thanks so much for all of that, I'll check my changes locally using your example.

glass-w commented 3 years ago

This has been superseded by #115