Mercurial > repos > ecology > xarray_import_data

annotate xarray_import_data.xml @ 0:6e079bcccb7e draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
author ecology
date Thu, 14 Aug 2025 08:53:58 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
1 <tool id="xarray_import_data" name="Xarray Import Data" version="0.1.0" profile="22.05">
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
2 <description>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
3 Import a dataset from an OPeNDAP URL and convert it to a local NetCDF file using xarray.
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
4 </description>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
5 <requirements>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
6 <requirement type="package" version="2025.4.0">xarray</requirement>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
7 <requirement type="package" version="3">python</requirement>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
8 <requirement type="package" version="1.6.0">netcdf4</requirement>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
9 </requirements>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
11 python '$__tool_directory__/xarray_import_data.py' '$opendap_url' '$decode_times' '$decode_cf' '$output_dataset'
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
12 ]]></command>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
13 <inputs>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
14 <param name="opendap_url" type="text" format="netcdf" label="OPeNDAP URL"
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
15 help="OPeNDAP URL to a dataset, also see https://docs.xarray.dev/en/stable/user-guide/io.html#opendap"
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
16 optional="false">
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
17 <validator type="regex" message="Type a valid url">^(https:|http:|\.)\S*</validator>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
18 </param>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
19 <param name="decode_times" type="boolean" label="Decode times"
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
20 help="If true, decode time variables to datetime objects. If false, keep them as raw data."
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
21 checked="true" />
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
22 <param name="decode_cf" type="boolean" label="Decode CF conventions"
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
23 help="Whether to decode according to CF conventions"
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
24 checked="true" />
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
25 </inputs>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
26 <outputs>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
27 <data name="output_dataset" from_work_dir="xarray_imported_data" format="netcdf"
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
28 label="xarray dataset" />
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
29 </outputs>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
30 <tests>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
31 <test>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
32 <param name="opendap_url"
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
33 value="http://test.opendap.org:8080/opendap/catalog/data/nc/data.nc" />
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
34 <output name="output_dataset" ftype="netcdf">
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
35 <assert_contents>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
36 <has_size min="17K" max="18K" />
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
37 </assert_contents>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
38 </output>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
39 </test>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
40 </tests>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
41 <help><![CDATA[
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
42 ==================
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
43 Xarray Import Data
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
44 ==================
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
45
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
46 **What it does**
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
47
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
48 Open a dataset from an OPeNDAP URL and convert it to a NetCDF file using xarray and netcdf4.
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
49
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
50 |
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
51
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
52 **How to use it**
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
53
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
54 Pass a valid OPeNDAP URL to the `opendap_url` parameter. The tool will download the dataset and save it as a local NetCDF file.
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
55
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
56 For big datasets consider subsetting the dataset in the url using `<URL>?var_name1[start:step:end],var_name2[start:step:end]`
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
57
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
58 |
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
59
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
60 **Links**
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
61 https://docs.xarray.dev/en/stable/user-guide/io.html#opendap
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
62 https://www.opendap.org/
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
63 ]]>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
64 </help>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
65 <citations>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
66 <citation type="doi">10.5334/jors.148</citation>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
67 </citations>
6e079bcccb7e planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/xarray_import_data commit 99843e9b86bfb355026559d36e29ed5a262aa9b0
ecology
parents:
diff changeset
68 </tool>