Skip to content
Open
Show file tree
Hide file tree
Changes from 30 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
13a2601
add WebAtlas
dannyspadaro Mar 3, 2026
8233bb9
fixed resolution parameter
dannyspadaro Mar 4, 2026
b71249c
added vitessce_options to build_config
dannyspadaro Mar 11, 2026
35c66af
fixed mappings handling in build_config to allow false values
dannyspadaro Mar 11, 2026
108d647
added modified build_config.py that works with galaxy. adjusted build…
dannyspadaro Mar 13, 2026
fd3266c
reordered parameter attributes to comply with iuc standards
dannyspadaro Mar 13, 2026
0cd5c0e
fixed tests and adjusted build_config params to function better in wo…
dannyspadaro Mar 16, 2026
aa1e49c
added zenodo links for test-data
dannyspadaro Mar 17, 2026
901a369
Add write_spatialdata.xml, switch to updated docker containers
dannyspadaro Mar 31, 2026
1540d6d
Restructured all tools, added sanitizers, added/fixed parameter help …
dannyspadaro Apr 2, 2026
34b1925
removed obsolete files
dannyspadaro Apr 2, 2026
bc2d3fe
fixed generate_image tests
dannyspadaro Apr 2, 2026
c3f2812
added proper filename for consolidate_md output
dannyspadaro Apr 4, 2026
27fa161
Replaced conditionals in vitessce_options with sections for workflows
dannyspadaro Apr 5, 2026
a134f3e
changed outputs of router + consolidate_md to zarr, removed unnecessa…
dannyspadaro Apr 5, 2026
2498267
Apply suggestions from code review
dannyspadaro Apr 7, 2026
7e1bc4a
added macros for sanitizers, changed asserts in build_config.xml
dannyspadaro Apr 7, 2026
40b4e92
added missing zenodo links to tests
dannyspadaro Apr 7, 2026
6796c5a
fixed if statements, removed default parameters in tests and use has_…
dannyspadaro Apr 8, 2026
e6558fa
changed vitessce options dimension help texts
dannyspadaro Apr 8, 2026
abb8456
fix custom_layout, add build_config help text, remove /usr/local/bin/…
dannyspadaro Apr 12, 2026
3ed298f
Apply suggestions from code review
dannyspadaro Apr 12, 2026
6cdd180
added tool help sections
dannyspadaro Apr 12, 2026
27aabb8
fix router.xml tests and add h5 asserts
pavanvidem Apr 28, 2026
fd21dba
typo in select
pavanvidem Apr 29, 2026
bab3e74
add asserts for consolidate_md
pavanvidem Apr 29, 2026
8a22392
fix zarr path in consolidate test
pavanvidem Apr 30, 2026
dd1191c
add .shed.yml
pavanvidem May 4, 2026
f4fad45
update the container
pavanvidem May 4, 2026
1b962c7
update the zenodo record
pavanvidem May 4, 2026
5f5d7f2
Update tools/webatlas/build_config.xml
pavanvidem May 4, 2026
e514d8e
add single quotes
pavanvidem May 4, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions tools/webatlas/.shed.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: webatlas
owner: iuc
description: The Galaxy WebAtlas tools to process spatial and single-cell experiment data for visualisation in a web browser using Vitessce.
homepage_url: https://github.com/haniffalab/webatlas-pipeline
long_description: The Galaxy WebAtlas tools provide a framework for processing spatial and single-cell experiment data, enabling visualisation with Vitessce.
remote_repository_url: https://github.com/bgruening/galaxytools/tree/master/tools/webatlas
categories:
- Spatial Omics
- Single Cell
auto_tool_repositories:
name_template: "{{ tool_id }}"
description_template: "Wrapper for {{ tool_name }}."
suite:
name: "suite_webatlas"
description: "A suite of Galaxy tools to process single-cell and spatial experiment data for visualisation using Vitessce."
type: repository_suite_definition
449 changes: 449 additions & 0 deletions tools/webatlas/build_config.xml

Large diffs are not rendered by default.

98 changes: 98 additions & 0 deletions tools/webatlas/consolidate_md.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<tool id="webatlas_consolidate_md" name="WebAtlas Consolidate Metadata" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" python_template_version="3.5" profile="@PROFILE_VERSION@">
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Can this tool be included in the build_config.xml as a background python script?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

consolidate_md is the tool with one of the longest runtimes out of all WebAtlas tools. Users might want to rerun only build_config to adjust Vitessce options, so I doubt including a long runtime tool would be convenient

<description>Converts an image to Zarr and consolidates metadata</description>
<macros>
<import>macros.xml</import>
</macros>
<expand macro="requirements"/>
<command detect_errors="exit_code"><![CDATA[
if tiffinfo $input_image | grep "Compression Scheme:" | grep -wq "JPEG";
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

single quotes

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

What is this doing? Can we not make decisions based on Galaxy metadata of those datasets?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

checks if it is a JPEG compressed TIFF image. I don't think this information is stored in the metadata.

then
if od -h -j2 -N2 $input_image | head -n1 | sed 's/[0-9]* *//' | grep -q -E '002b|2b00';
then
tiffcp -c none -m 0 -8 $input_image uncompressed.tiff;
else
tiffcp -c none -m 0 $input_image uncompressed.tiff || tiffcp -c none -m 0 -8 $input_image uncompressed.tiff;
fi;
bioformats2raw --no-hcs uncompressed.tiff $stem-'$image_type'.zarr;
else
bioformats2raw --no-hcs $input_image $stem-'$image_type'.zarr;
fi;
consolidate_md.py --file_in $stem-'$image_type'.zarr &&
mkdir -p '$output_zarr.extra_files_path' &&
mv $stem-'$image_type'.zarr $output_zarr.extra_files_path
]]></command>
<inputs>
<param name="input_image" type="data" format="tif,tiff,jpg" label="TIFF or JPEG image" help="Input image to convert to Zarr. JPEG-compressed TIFF images are automatically decompressed before conversion."/>
<expand macro="stem"/>
<param name="image_type" type="select" label="Input image type" help="Choose the type of input image.">
<option value="label">label</option>
<option value="raw">raw</option>
</param>
</inputs>
<outputs>
<data name="output_zarr" format="zarr" label="${tool.name} on ${on_string}: Zarr output"/>
</outputs>
<tests>
<test expect_num_outputs="1">
<param name="input_image" location="https://zenodo.org/records/20029977/files/visium-breast-cancer-label.tif"/>
<param name="stem" value="visium-breast-cancer"/>
<param name="image_type" value="label"/>
<output name="output_zarr">
<extra_files type="file" name="visium-breast-cancer-label.zarr/OME/METADATA.ome.xml">
<assert_contents>
<has_text text="&lt;Description&gt;{&quot;shape&quot;: [21571, 19505]}&lt;/Description&gt;&lt;Pixels BigEndian=&quot;true&quot; DimensionOrder=&quot;XYZCT&quot;"/>
</assert_contents>
</extra_files>
</output>
</test>
<test expect_num_outputs="1">
<param name="input_image" location="https://zenodo.org/records/20029977/files/tissue_image.tif"/>
<param name="stem" value="visium-breast-cancer"/>
<param name="image_type" value="raw"/>
<output name="output_zarr">
<extra_files type="file" name="visium-breast-cancer-raw.zarr/OME/METADATA.ome.xml">
<assert_contents>
<has_text_matching expression="Pixels BigEndian=&quot;true&quot; DimensionOrder=&quot;XYZCT&quot; ID=&quot;Pixels:0&quot; Interleaved=&quot;false&quot; PhysicalSizeX=&quot;0.5475[0-9]+&quot; PhysicalSizeXUnit=&quot;µm&quot; PhysicalSizeY=&quot;0.5476[0-9]+&quot; PhysicalSizeYUnit=&quot;µm&quot; SignificantBits=&quot;8&quot; SizeC=&quot;3&quot; SizeT=&quot;1&quot; SizeX=&quot;19505&quot; SizeY=&quot;21571&quot; SizeZ=&quot;1&quot; Type=&quot;uint8&quot;"/>
</assert_contents>
</extra_files>
</output>
</test>
</tests>
<help><![CDATA[
This tool converts image data into the Zarr format and consolidates its metadata to improve performance in downstream visualization.

It typically processes label images generated by **WebAtlas Generate Image** and raw images provided as input or generated within the WebAtlas workflow.

----

**Supported Input Types**

- **TIFF image** (including JPEG-compressed TIFF)
- **JPEG image**

----

**Processing Steps**

- (If applicable) Decompression of JPEG-compressed TIFF images prior to conversion
- Conversion of the input image to Zarr format using *bioformats2raw*
- Consolidation of Zarr metadata

----

**Metadata Consolidation**

Zarr datasets normally store metadata in many small files. This tool consolidates them into a single metadata file.

This can significantly reduce the time necessary to load the metadata in downstream visualization.

----

**Output**

- **Zarr dataset (image with consolidated metadata)**

The output is used as input for the downstream WebAtlas tools **WebAtlas OME Zarr Metadata**, **WebAtlas Build Vitessce Config**, and **WebAtlas Write**.
]]></help>
<expand macro="citations"/>
</tool>
Loading
Loading