Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tutorial on how to create high-res Workflow Screenshots #4553

Merged

Conversation

ElectronicBlueberry
Copy link
Member

Some steps in this tutorial require Galaxy version 23.2

Adds a tutorial on how to create high-resolution screenshots of Galaxy Workflows using external tools, and compressing said screenshots.

Feel free to review the tutorial in it's current stage. This PR is in draft-mode because Galaxy 23.2 is not yet released.

Copy link
Member

@hexylena hexylena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't ever know about the --dpr argument, how cool. I'd just been using the button ff provides. https://blog.nightly.mozilla.org/2018/08/23/screenshots-from-the-console/ very neat

overall it's great that this is an option that will work tomorrow¹, I've added some discussion about maybe more user-friendly alternatives that I'd be interested to hear your thoughts on!

¹ whenever 23.2 is out

There are third party tools which can help us in making high resolution screenshots that preserve all details
and produce pictures which are suitable for printing and sharing.

{% include _includes/cyoa-choices.html option1="Print" option2="Web" default="Print"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, awesome!!

ElectronicBlueberry and others added 2 commits December 4, 2023 12:07
Co-authored-by: Helena <hexylena@galaxians.org>
Co-authored-by: Helena <hexylena@galaxians.org>
@ElectronicBlueberry
Copy link
Member Author

Regarding the suggestions for a more user-friendly approach:

I would love to do something more integrated in the long run. I think a hidden tool, which is triggered through an option in the workflow editor (and/or workflow view) may be the best long-term approach. A problem which this poses is that currently the Workflow would need to be published for the web driver to see it.

Regarding the "Print-View" button, I think it goes hand in hand with the functionality mentioned above. If the print-preview exists without a print button, it may be a bit confusing.

I think this makes sense to track in a issue in the main Galaxy repo. Would you like to open one?

That being said adding a tool which operates on published workflows in the mean time may be a better approach than the console tutorial (though I'm not 100% sure about this, since both have trade-offs regarding user experience). Would you still want to add this tutorial in it's current state and edit it later, or wait for such a tool to be written?


I didn't know about graphicsmagick before, it looks neat!

@hexylena
Copy link
Member

hexylena commented Dec 4, 2023

That makes a lot of sense! a hidden tool could definitely be a great solution there.

A problem which this poses is that currently the Workflow would need to be published for the web driver to see it.

ah bad suggestion but one could conceive of just injecting the user's API key into said tool, like we do for ITs. I'm sure there's something more sustainable long term though, so ignore this comment :)

I think this makes sense to track in a issue in the main Galaxy repo. Would you like to open one?

sure I can do that!

Would you still want to add this tutorial in it's current state and edit it later, or wait for such a tool to be written?

Yes, let's still ship this tutorial, it will be useful immediately which is already an improvement!

I'll see about updating the convert tool in the meantime, because then users could do this without installing software (other than switching to a better browser that respects their rights and privacy and freedom), and maybe galaxy is more friendly than linux only tools for that step.

@hexylena
Copy link
Member

hexylena commented Dec 4, 2023

I didn't know about graphicsmagick before, it looks neat!

i'll be honest i never understood the difference between graphicsmagick magick and imagemagick, I always suspected it was just distros being weird and renaming things, or an ffmpeg/libav situation, since it seems to be identical commands with identical featuresets between them, but they're apparently different suites. the commands were always so similar and in some places aliased, that I couldn't tell them apart.

https://stackoverflow.com/questions/862051/what-is-the-difference-between-imagemagick-and-graphicsmagick from which my takeaway is I will keep using imagemagick locally and never install gm

that said in this case, surprisingly, it matters

$ convert -version
Version: ImageMagick 7.1.1-15 Q16-HDRI x86_64 21298 https://imagemagick.org
Copyright: (C) 1999 ImageMagick Studio LLC
License: https://imagemagick.org/script/license.php
Features: Cipher DPC HDRI Modules OpenMP(4.5) 
Delegates (built-in): bzlib cairo djvu fftw fontconfig freetype gslib gvc heic jbig jng jp2 jpeg jxl lcms lqr ltdl lzma openexr pangocairo png ps raqm raw rsvg tiff webp wmf x xml zip zlib
Compiler: gcc (13.2)
$ gm convert -version
GraphicsMagick 1.3.40 2023-01-14 Q16 http://www.GraphicsMagick.org/
Copyright (C) 2002-2023 GraphicsMagick Group.
Additional copyrights and licenses apply to this software.
[...]
graphicsmagick imagemagick
dithering is very apparent here, there are many dots on one side of the image of donald. here the background is a more uniform colour
16kb 8kb

@hexylena
Copy link
Member

I followed this today to make some screenshots for WorkflowHub! It worked great :) I've replaced the imagemagick section with a version following the same steps in Galaxy now that the tool is updated. I think this is ready to be merged, if it's OK for you @ElectronicBlueberry?

@hexylena
Copy link
Member

i looked into whether or not we should add a "23.2 only" disclaimer, but you make that explicit, and then add a debugging step if that URL fails to work, so, I think it's fine to ship this now.

@hexylena hexylena marked this pull request as ready for review January 23, 2024 12:42
@hexylena hexylena requested review from a team, bebatut and shiltemann as code owners January 23, 2024 12:42
@ElectronicBlueberry
Copy link
Member Author

I followed this today to make some screenshots for WorkflowHub! It worked great :) I've replaced the imagemagick section with a version following the same steps in Galaxy now that the tool is updated. I think this is ready to be merged, if it's OK for you @ElectronicBlueberry?

Yes, it's ok to merge for me!

@hexylena hexylena merged commit 9b18ed7 into galaxyproject:main Feb 5, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants