annotate iscc_sum.xml @ 0:01155dd89628 draft

planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
author imgteam
date Thu, 06 Nov 2025 10:22:33 +0000
parents
children 2812afc5f30a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
1 <tool id="iscc_sum" name="Generate ISCC hash" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="24.1">
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
2 <description>with ISCC-SUM</description>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
3
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
4 <macros>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
5 <import>macros.xml</import>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
6 <import>creators.xml</import>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
7 </macros>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
8 <expand macro="requirements" />
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
9 <expand macro="version_command" />
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
10 <creator>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
11 <expand macro="creators/iscc" />
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
12 <expand macro="creators/lco" />
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
13 <expand macro="creators/maartenpaul" />
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
14 <expand macro="creators/etzm" />
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
15 </creator>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
16
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
17 <command detect_errors="exit_code"><![CDATA[
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
18 iscc-sum '$input_file' | cut -d':' -f2 | cut -d' ' -f1 > '${output_file}'
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
19 ]]></command>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
20
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
21 <inputs>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
22 <param name="input_file" type="data" format="data" label="Input File"
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
23 help="Any file type - ISCC-SUM will generate a checksum and similarity hash"/>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
24 </inputs>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
25
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
26 <outputs>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
27 <data name="output_file" format="txt" label="${tool.name} on ${on_string}"/>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
28 </outputs>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
29
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
30 <tests>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
31 <test expect_num_outputs="1">
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
32 <param name="input_file" value="test1.png"/>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
33 <output name="output_file">
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
34 <assert_contents>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
35 <has_line line="K4AOMGOGQJA4Y46PAC4YPPA63GKD5RVFPR7FU3I4OOEW44TYXNYOTMY" />
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
36 </assert_contents>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
37 </output>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
38 </test>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
39 <test expect_num_outputs="1">
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
40 <param name="input_file" value="test2.tiff"/>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
41 <output name="output_file">
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
42 <assert_contents>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
43 <has_line line="K4AGSPOSB5SS2X427WZ27QASTSBVTS55DXLMFDF7WOJKEOSTDEI3OXQ" />
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
44 </assert_contents>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
45 </output>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
46 </test>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
47 <test expect_num_outputs="1">
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
48 <param name="input_file" value="test3.fasta"/>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
49 <output name="output_file">
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
50 <assert_contents>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
51 <has_line line="K4AKF7PTZ7JTAAYZ7YZHZPR5RETKYXXE7RTBTJA4JX5GQQMSLZRC6QQ" />
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
52 </assert_contents>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
53 </output>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
54 </test>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
55 </tests>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
56
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
57 <help><![CDATA[
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
58 **What it does**
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
59
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
60 Generates an International Standard Content Code (ISCC) based checksum and similarity hash from any input file.
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
61
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
62 The ISCC-SUM is a content-derived identifier that:
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
63 - Creates a unique checksum based on file content
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
64 - Generates a similarity hash for content comparison
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
65 - Works with any file format
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
66
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
67 **Input**
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
68
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
69 Any file format is accepted as input.
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
70
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
71 **Output**
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
72
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
73 A text file containing the ISCC-SUM code for the input file.
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
74
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
75 **More Information**
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
76
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
77 For more details about ISCC, visit: https://iscc.codes/
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
78 ]]></help>
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
79
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
80 <expand macro="citations" />
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
81
01155dd89628 planemo upload for repository https://github.com/BMCV/galaxy-image-analysis/tree/master/tools/iscc-sum commit e2d8293c17c87553b267747c6a7b10b9b3ddd0d2
imgteam
parents:
diff changeset
82 </tool>