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

Documentation of slicer_cli_web to work with DSA? #353

Open
pearcetm opened this issue Aug 20, 2024 · 2 comments
Open

Documentation of slicer_cli_web to work with DSA? #353

pearcetm opened this issue Aug 20, 2024 · 2 comments

Comments

@pearcetm
Copy link

My team and I are struggling to find clear documentation of how to use slicer_cli_web to build image analysis tasks.

Specifically, we discovered by trial and error and looking at other examples that <longflag>outputAnnontationFile</longflag> must be set in order for a json file returned by the job to be used by the DSA as an annotation. <longflag>output_file</longflag> works differently.

Now we understand this (or at least we think we understand), but it would be great to have some official documentation so we know what we are actually doing. Does that exist somewhere? Apologies if I've overlooked it.

@manthey
Copy link
Contributor

manthey commented Aug 20, 2024

The DSA uses the slicer cli execution schema with a few modifications. The reference to this is split (and should definitely be improved). Specifically, much of the girder-specifics are documented here: https://github.com/girder/slicer_cli_web?tab=readme-ov-file#docker-clis including a link to the base schema (https://www.slicer.org/w/index.php?title=Documentation/Nightly/Developers/SlicerExecutionModel). There are some Histomics specific further changes that are documented here: https://github.com/DigitalSlideArchive/HistomicsUI?tab=readme-ov-file#annotations-and-metadata-from-jobs; but looking at that it isn't particularly clear that this modifies the slicer cli execution schema.

I'll add an issue in the HistomicsUI space to make this documentation clearer and to add some illustrative examples.

@pearcetm
Copy link
Author

but looking at that it isn't particularly clear that this modifies the slicer cli execution schema.

I'll add an issue in the HistomicsUI space to make this documentation clearer and to add some illustrative examples.

Thanks for the quick reply. The HistomicsUI docs seem to touch on this most directly. It would really be great to get some better examples and clearer (possibly consolidated) documentation. Thanks for opening that new issue!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants