annotate hedm_npz_to_tesr.xml @ 4:b49a8ef3351d draft

"planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
author ximgchess
date Thu, 01 Apr 2021 18:29:39 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
1 <tool id="hedm_npz_to_tesr" name="HEDM to tesr" version="0.1.0" python_template_version="3.5">
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
2 <description>Convert HEDM npz to a Neper tesr</description>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
3 <requirements>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
4 <requirement type="package" version="1.19">numpy</requirement>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
5 </requirements>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
6 <command detect_errors="exit_code"><![CDATA[
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
7 $__tool_directory__/hedm_npz_to_tesr.py
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
8 --voxel_spacing $voxel_spacing
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
9 #if $names.x_name:
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
10 -x '$names.x_name'
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
11 #end if
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
12 #if $names.y_name:
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
13 -y '$names.y_name'
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
14 #end if
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
15 #if $names.z_name:
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
16 -z '$names.z_name'
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
17 #end if
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
18 #if $names.grain_map:
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
19 --grain_map '$names.grain_map'
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
20 #end if
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
21 '$input'
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
22 '$output'
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
23 ]]></command>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
24 <inputs>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
25 <!-- change format to approriate npz subclass when available -->
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
26 <param name="input" type="data" format="zip" label="HEDM npz file"/>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
27 <param name="voxel_spacing" type="float" value="0.005" min="0" label="Voxel spacing"/>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
28 <section name="names" expanded="false" title="Specify names used in HEDM.npz input file">
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
29 <param name="x_name" type="text" value="" label="Name of the X array in the input" optional="true" help="Deafault is a name containing 'X'"/>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
30 <param name="y_name" type="text" value="" label="Name of the Y array in the input" optional="true" help="Deafault is a name containing 'Y'"/>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
31 <param name="z_name" type="text" value="" label="Name of the Z array in the input" optional="true" help="Deafault is a name containing 'Z'"/>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
32 <param name="grain_map" type="text" value="" label="Name of the grain map in the input" optional="true" help="Deafault is a name containing 'grain'"/>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
33 </section>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
34 </inputs>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
35 <outputs>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
36 <!-- output format should be changed to tesr when that is available -->
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
37 <data name="output" format="txt" label="${input.name.rsplit(sep='.',maxsplit=1)[0]}.tesr"/>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
38 </outputs>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
39 <tests>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
40 <test>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
41 <!-- change format to approriate npz subclass when available -->
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
42 <param name="input" ftype="zip" value="HEDM_map.npz"/>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
43 <output name="output" file="HEDM_map.tesr"/>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
44 </test>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
45 </tests>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
46 <help><![CDATA[
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
47 Create a neper compatible tesr format file from a HEDM numpy compressed file.
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
48 The converter will look for columns named: Xs, Ys, Zs, and grain_map by default,
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
49 If the input file uses different names, the user should specify them.
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
50 ]]></help>
b49a8ef3351d "planemo upload for repository https://github.com/ximg-chess/galaxytools/tools/hedm_npz_to_tesr commit 0db0d2633f65e2ceca2e34c8899a52b18965d059"
ximgchess
parents:
diff changeset
51 </tool>