annotate divandfull.xml @ 1:42b317c31d5c draft default tip

planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit a7e53c429cf93485aba692b928defe6ee01633d6
author ecology
date Tue, 22 Oct 2024 15:54:37 +0000
parents dae0fb5e0ee0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
1 <tool id="divand_full_analysis" name="DIVAnd" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="20.01" license="MIT">
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
2 <description>Data-Interpolating Variational Analysis in n dimensions</description>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
3 <macros>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
4 <token name="@TOOL_VERSION@">0.1.0</token>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
5 <token name="@VERSION_SUFFIX@">0</token>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
6 </macros>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
7 <requirements>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
8 <requirement type="package" version="1.8.5">julia</requirement>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
9 <requirement type="package" version="2.7.9">julia-divand</requirement>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
10 </requirements>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
12 ## The HOME .julia folder is not writable inside the Docker container, so we need to set one that is writable.
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
13 export JULIA_DEPOT_PATH="\$PWD:\$JULIA_DEPOT_PATH" &&
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
14 julia
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
15 '$__tool_directory__/divandfull.jl'
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
16 '$input_netcdf_identifier'
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
17 '$longmin'
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
18 '$longmax'
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
19 '$latmin'
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
20 '$latmax'
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
21 '$startdate'
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
22 '$enddate'
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
23 '$varname'
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
24 '$selmin'
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
25 '$selmax'
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
26 '$bathname'
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
27 ]]></command>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
28 <inputs>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
29 <param name="input_netcdf_identifier" type="data" format="netcdf" label="Input your netcdf data"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
30 <param name="bathname" type="data" format="netcdf" label="Input your bathymetry netcdf file" help="for more info see below."/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
31 <param name="longmin" type="float" min="-180" max="180" value="0" label="Longitude minimal"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
32 <param name="longmax" type="float" min="-180" max="180" value="0" label="Longitude maximal"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
33 <param name="latmin" type="float" min="-180" max="180" value="0" label="Latitude minimal"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
34 <param name="latmax" type="float" min="-180" max="180" value="0" label="Latitude maximal"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
35 <param name="startdate" type="text" value="yyyy-mm-dd" label="Input the starting date">
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
36 <sanitizer invalid_char="">
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
37 <valid initial="string.digits">
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
38 <add value="-"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
39 </valid>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
40 </sanitizer>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
41 </param>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
42 <param name="enddate" type="text" value="yyyy-mm-dd" label="Input the ending date">
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
43 <sanitizer invalid_char="">
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
44 <valid initial="string.digits">
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
45 <add value="-"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
46 </valid>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
47 </sanitizer>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
48 </param>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
49 <param name="varname" type="text" value="variable" label="Write the name of the variable of the analysis" help="Example: phosphate">
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
50 <sanitizer invalid_char="">
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
51 <valid initial="string.letters">
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
52 <add value="_"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
53 </valid>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
54 </sanitizer>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
55 <validator type="regex">[0-9a-zA-Z_]+</validator>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
56 </param>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
57 <param name="selmin" type="integer" min="0" max="100" optional="true" value="0" label="Minimum of the salinity"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
58 <param name="selmax" type="integer" min="0" max="100" optional="true" value="0" label="Maximum of the salinity"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
59 </inputs>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
60 <outputs>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
61 <data name="output_netcdf" label="DIVAnd netcdf output" from_work_dir="outputs_netcdf/*.nc" format="netcdf"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
62 </outputs>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
63 <tests>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
64 <test expect_num_outputs="1">
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
65 <param name="input_netcdf_identifier" value="data_from_Eutrophication_Med_profiles_2022_unrestricted.nc"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
66 <param name="bathname" location="https://dox.ulg.ac.be/index.php/s/U0pqyXhcQrXjEUX/download"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
67 <param name="longmin" value="19.0"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
68 <param name="longmax" value="30.0"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
69 <param name="latmin" value="32.0"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
70 <param name="latmax" value="38.0"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
71 <param name="varname" value="phosphate"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
72 <param name="startdate" value="1950-01-01"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
73 <param name="enddate" value="2017-12-31"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
74 <param name="selmin" value="0"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
75 <param name="selmax" value="100"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
76 <output name="output_netcdf">
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
77 <assert_contents>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
78 <has_size value="68291" delta="0"/>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
79 </assert_contents>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
80 </output>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
81 </test>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
82 </tests>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
83 <help><![CDATA[
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
84
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
85 .. class:: infomark
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
86
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
87 **What it does**
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
88
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
89 This tool takes a observation netcdf file and create climatology
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
90
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
91 **Input**
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
92
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
93 - An ocean observation netcdf file
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
94 - A bathymetry netcdf file, you can download it like this: download("https://dox.ulg.ac.be/index.php/s/U0pqyXhcQrXjEUX/download", "gebco_30sec_8.nc")
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
95 - Some complementary information for the tool to better understand your data and create your climatology on the right area: latitudes, longitudes, dates, and salinity.$
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
96
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
97 **Output**
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
98
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
99 One netcdf file containing the climatology created by DIVAnd.
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
100
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
101
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
102 **A bit of context**
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
103
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
104 DIVAnd (Data-Interpolating Variational Analysis in n dimensions) performs an n-dimensional variational analysis/gridding of
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
105 arbitrarily located observations. Observations will be interpolated/analyzed on a curvilinear grid in 1, 2, 3 or more dimensions.
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
106 In this sense it is a generalization of the original two-dimensional DIVA version (still available `here <https://github.com/gher-uliege/DIVA>`_ but
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
107 not further developed anymore).
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
108
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
109 The method bears some similarities and equivalences with Optimal Interpolation or Krigging in that it allows to create a smooth
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
110 and continous field from a collection of observations, observations which can be affected by errors. The analysis method is however
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
111 different in practise, allowing to take into account topological features, physical constraints etc in a natural way.
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
112 The method was initially developped with ocean data in mind, but it can be applied to any field where localized observations have
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
113 to be used to produce gridded fields which are "smooth".
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
114
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
115 DIVAndrun is the core analysis function in n dimensions. It does not know anything about the physical parameters or units you work with.
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
116 Coordinates can also be very general. The only constraint is that the metrics (pm,pn,po,...) when multiplied by the corresponding length
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
117 scales len lead to non-dimensional parameters. Furthermore the coordinates of the output grid (xi,yi,zi,...) need to have the same units
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
118 as the observation coordinates (x,y,z,...).
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
119
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
120 DIVAndfun is a version with a minimal set of parameters (the coordinates and values of observations, i.e. (x,f), the remaining parameters
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
121 being optional) and provides an interpolation function rather than an already gridded field.
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
122
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
123 diva3D is a higher-level function specifically designed for climatological analysis of data on Earth, using longitude/latitude/depth/time
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
124 coordinates and correlations length in meters. It makes the necessary preparation of metrics, parameter optimizations etc you normally would
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
125 program yourself before calling the analysis function DIVAndrun.
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
126
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
127 DIVAnd_heatmap can be used for additive data and produces Kernel Density Estimations.
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
128
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
129 DIVAndgo is only needed for very large problems when a call to DIVAndrun leads to memory or CPU time problems. This function tries to decide
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
130 which solver (direct or iterative) to use and how to make an automatic domain decomposition. Not all options from DIVAndrun are available.
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
131
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
132 If you want to try out multivariate approaches, you can look at DIVAnd_multivarEOF and DIVAnd_multivarJAC
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
133
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
134 If you want more informations about the functions and parameters see also the `documentations here <https://gher-uliege.github.io/DIVAnd.jl/latest/index.html>`_.
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
135
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
136 ]]></help>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
137 <citations>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
138 <citation type="doi">doi:10.5194/gmd-7-225-2014</citation>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
139 </citations>
dae0fb5e0ee0 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/ocean commit e395cfee9cab90bbed58ac52fb8467c896f51824
ecology
parents:
diff changeset
140 </tool>