annotate xarray_metadata_info.xml @ 1:7edbe5ae8b72 draft

"planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit f1455c158011dc4aab0fd469cf794be6f4142992"
author ecology
date Fri, 22 May 2020 05:18:55 -0400
parents 965fcab0cd9f
children e8650cdf092f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
1 <tool id="xarray_metadata_info" name="NetCDF xarray Metadata Info" version="0.15.1">
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
2 <description>summarize content of a Netcdf file</description>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
3 <requirements>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
4 <requirement type="package" version="3">python</requirement>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
5 <requirement type="package" version="1.5.3">netcdf4</requirement>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
6 <requirement type="package" version="0.15.1">xarray</requirement>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
7 <requirement type="package" version="0.7.0">geopandas</requirement>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
8 <requirement type="package" version="1.7.0">shapely</requirement>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
9 </requirements>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
11 python3 '$__tool_directory__/xarray_tool.py' '$input' --info '$info' --summary '$output'
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
12 ]]></command>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
13 <inputs>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
14 <param type="data" name="input" label="Netcdf file" format="netcdf,h5" help="Netcdf file you need information about."/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
15 </inputs>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
16 <outputs>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
17 <data name="output" format="tabular" label="Metadata infos from ${input.name}" from_work_dir="variables.tabular"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
18 <data name="info" label="info file" format="txt"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
19 </outputs>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
20 <tests>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
21 <test>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
22 <param name="input" value="dataset-ibi-reanalysis-bio-005-003-monthly-regulargrid_1510914389133.nc"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
23 <param name="output" value="Metadata_infos_from_dataset-ibi-reanalysis-bio-005-003-monthly-regulargrid_1510914389133.nc.Variables.tab"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
24 <output name="info" value="info_file.txt">
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
25 <assert_contents>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
26 <has_text_matching expression="depth\s+=\s+1"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
27 <has_text_matching expression="latitude\s+=\s+97"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
28 <has_text_matching expression="longitude\s+=\s+103"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
29 <has_text_matching expression="time\s+=\s+145"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
30 </assert_contents>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
31 </output>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
32 <output name="output" ftype="tabular" file="Metadata_infos_from_dataset-ibi-reanalysis-bio-005-003-monthly-regulargrid_1510914389133.nc.Variables.tab">
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
33 <assert_contents>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
34 <has_text_matching expression="VariableName\tNumberOfDimensions\tDim0Name\tDim0Size\tDim1Name\tDim1Size\tDim2Name\tDim2Size\tDim3Name\tDim3Size"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
35 <has_text_matching expression="phy\t4\ttime\t145\tdepth\t1\tlatitude\t97\tlongitude\t103"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
36 <has_text_matching expression="chl\t4\ttime\t145\tdepth\t1\tlatitude\t97\tlongitude\t103"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
37 <has_text_matching expression="nh4\t4\ttime\t145\tdepth\t1\tlatitude\t97\tlongitude\t103"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
38 <has_text_matching expression="time\t1\ttime\t145"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
39 <has_text_matching expression="longitude\t1\tlongitude\t103"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
40 <has_text_matching expression="latitude\t1\tlatitude\t97"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
41 <has_text_matching expression="depth\t1\tdepth\t1"/>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
42 </assert_contents>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
43 </output>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
44 </test>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
45 </tests>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
46 <help><![CDATA[
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
47 **What it does**
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
48
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
49 First the tool will give general information about the input in a 'info file' output. (command $ncdump -h inputfile)
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
50
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
51 Then, a general tabular 'variables' summarize dimensions details inside each available variable.
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
52
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
53
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
54 The summary tabular file has the general structure :
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
55
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
56
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
57 Variable1 Var1_Number_of_Dim Dim1 Dim1_size ... DimN DimN_size
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
58
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
59 VariableX VarX_Number_of_Dim DimX1 DimX1_size ... DimXN DimXN_size
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
60
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
61 ...
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
62
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
63
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
64 **Input**
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
65
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
66 A netcdf file (xxx.nc).
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
67
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
68 **Outputs**
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
69
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
70 An Information file.
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
71
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
72 A summary tabular file.
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
73
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
74
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
75 --------------------------------
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
76
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
77 The Netcdf Info tool use the netcdf functions : https://www.unidata.ucar.edu/software/netcdf/docs/index.html
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
78
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
79 Run this tool before considering using Netcdf Read.
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
80 ]]></help>
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
81
965fcab0cd9f "planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/data_manipulation/xarray/ commit 812c1c92d6596722642515ba99c5efab113b6a68"
ecology
parents:
diff changeset
82 </tool>