Skip to content

Commit bf6cd39

Browse files
authored
Update qcv tools (#179)
* Update version + add logs * versio + logs * fix typo error * Update bgc_calib.xml
1 parent 176da50 commit bf6cd39

3 files changed

Lines changed: 24 additions & 25 deletions

File tree

tools/ocean_data_view_manager/bgc_calib.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<description>for sensors according to Argo recommendations</description>
33
<macros>
44
<token name="@VERSION@">1.0</token>
5-
<token name="@VERSION_SUFFIX@">1</token>
5+
<token name="@VERSION_SUFFIX@">2</token>
66
</macros>
77
<requirements>
88
<container type="docker">easyqcvbgc/easy-qcv_calibration-methods_tool:@VERSION@</container>

tools/ocean_data_view_manager/tool_odv.xml

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<tool id="tool_odv" name="ODV collection manager" version="@VERSION@+galaxy@VERSION_SUFFIX@" profile="22.05" license="MIT">
22
<description>tool for qualificiation and validation</description>
33
<macros>
4-
<token name="@VERSION@">1.2</token>
4+
<token name="@VERSION@">1.3</token>
55
<token name="@VERSION_SUFFIX@">1</token>
66
</macros>
77
<requirements>
8-
<container type="docker">easyqcvbgc/easy-qcv_odv-coll-manager_tool:@VERSION@</container>
8+
<container type="docker">easyqcvbgc/easy-qcv_odv-coll-manager_tool:oc@VERSION@</container>
99
</requirements>
1010
<command detect_errors="exit_code"><![CDATA[
1111
export HOME=\$PWD &&
@@ -37,6 +37,7 @@
3737
3838
/app/launchers/start-app.sh &&
3939
cp '/runtime/data-out/odv_collection.txt' '$output' &&
40+
cp -r '/runtime/log/' './outputs/' &&
4041
4142
cp -r '/runtime/data-out/' './outputs/'
4243
]]></command>
@@ -123,7 +124,7 @@
123124
<has_n_lines n="26363"/>
124125
</assert_contents>
125126
</output>
126-
<output_collection name="files" type="list" count="3"/>
127+
<output_collection name="files" type="list" count="6"/>
127128
</test>
128129
<test expect_num_outputs="2">
129130
<param name="input_raw" location="https://gitlab.com/pokapok-projects/easy-qcv-bgc/qcv-odv-tool/-/raw/7b3557c89438b7347c601d6959af354103b167a1/galaxy_tool/test-data/data_raw.nc"/>
@@ -139,7 +140,7 @@
139140
<has_n_lines n="17952"/>
140141
</assert_contents>
141142
</output>
142-
<output_collection name="files" type="list" count="3"/>
143+
<output_collection name="files" type="list" count="6"/>
143144
</test>
144145
</tests>
145146
<help><![CDATA[
@@ -157,17 +158,11 @@ This tool present two type of actions :
157158
158159
- file_name_raw : nc file to be qualified
159160
- file_name_ref : nc file used for validation / comparison. noted NULL if no files
160-
- odv_collection$qc_convention : tool makes mapping when its necessary and when global attribute qc_convention is available and filled in file_name_raw
161-
- tool_option$subsetting : 1 apply a subbsetting to ref data searching the smallest box (default) / 0 no subsetting / -1 apply an inverse subseting
162-
- tool_option$plt : figure option to see the subseted box (0 or 1) - default name subset_box.png
163-
164-
with default values different from NULL :
165-
166-
- odv_collection$name : odv_collection.txt
167-
- odv_collection$qc_convention : ARGO
168-
- tool_action :
169-
- tool_option$subsetting :
170-
- tool_option$plt :
161+
- operator : (optional) name of the person working on dataset qualification / validation
162+
- odv_collection$name : name of the odv collection created by the tool (by default = odv_collection.txt)
163+
- odv_collection$qc_convention : tool makes mapping when its necessary and when global attribute qc_convention is available and filled in file_name_raw (by default = ARGO)
164+
- tool_option$subsetting : 1 apply a subsetting to ref data searching the smallest box (by default) / 0 no subsetting / -1 apply an inverse subsetting
165+
- tool_option$plt : figure option to see the subsetted box (0 - by default - or 1) - default name *subset_box.png*
171166
172167
If the list of raw file name is empty, tool stops If the user make an error in the file extension, tool changes it by itself. If the user miss the yaml configuration, tool uses its default config and upload file in data-in-raw and data-in-ref
173168

tools/ocean_data_view_manager/tool_odv_history.xml

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<tool id="tool_odv_history" name="ODV history manager" version="@VERSION@+galaxy@VERSION_SUFFIX@" profile="22.05" license="MIT">
22
<description>reports user action performed with ODV</description>
33
<macros>
4-
<token name="@VERSION@">1.1</token>
4+
<token name="@VERSION@">1.2</token>
55
<token name="@VERSION_SUFFIX@">1</token>
66
</macros>
77
<requirements>
8-
<container type="docker">easyqcvbgc/easy-qcv_odv-history-manager_tool:@VERSION@</container>
8+
<container type="docker">easyqcvbgc/easy-qcv_odv-history-manager_tool:oh@VERSION@</container>
99
</requirements>
1010
<command detect_errors="exit_code"><![CDATA[
1111
export HOME=\$PWD &&
@@ -38,7 +38,7 @@
3838
#end if
3939
4040
/app/launchers/start-app.sh &&
41-
###cp '/runtime/data-out/*data_0_qced.nc' '$output' &&
41+
cp -r '/runtime/log/' './outputs/' &&
4242
4343
cp -r '/runtime/data-out/' './outputs/'
4444
]]></command>
@@ -78,7 +78,7 @@
7878
</configfile>
7979
</configfiles>
8080
<inputs>
81-
<param name="input_raw" type="data" format="netcdf" multiple="true" label="Input netcdf data" help="This netcdf should come from the QCV harmonizer tool"/>
81+
<param name="input_raw" type="data" format="netcdf" multiple="true" label="Input netcdf data" help="This netcdf should come from the QCV harmonizer tool or the BioGeoChemical calibration tool "/>
8282
<param name="input_hist" type="data" format="txt" multiple="true" label="Input history text file" help="This text file should be the history extracted from the Ocean Data View (ODV) tool"/>
8383
<param name="input_odv" type="data" format="txt" multiple="true" optional="true" label="Input odv file" help="This ODV file should be the odv_collection.txt from the ODV collection manager tool."/>
8484
<conditional name="config">
@@ -120,9 +120,12 @@
120120
<collection type="list" name="csv_files" label="ODV history manager csv collection">
121121
<discover_datasets pattern="(?P&lt;designation&gt;.+)\.csv" directory="./outputs" recurse="true" format="csv"/>
122122
</collection>
123+
<collection type="list" name="log_files" label="ODV history manager log files">
124+
<discover_datasets pattern="(?P&lt;designation&gt;.+)\.log" directory="./outputs" recurse="true" format="txt"/>
125+
</collection>
123126
</outputs>
124127
<tests>
125-
<test expect_num_outputs="2">
128+
<test expect_num_outputs="3">
126129
<param name="input_raw" location="https://gitlab.com/pokapok-projects/easy-qcv-bgc/qcv-bgc-tools/-/raw/fe047f301f0c384ad0668a73dfe776d9ac482d0f/galaxy_tool/test-data/QCV_harmonizer_NetCDF_data_0.nc"/>
127130
<param name="input_hist" location="https://gitlab.com/pokapok-projects/easy-qcv-bgc/qcv-bgc-tools/-/raw/fe047f301f0c384ad0668a73dfe776d9ac482d0f/galaxy_tool/test-data/history_from_odv_collection.txt"/>
128131
<param name="input_odv" location="https://gitlab.com/pokapok-projects/easy-qcv-bgc/qcv-bgc-tools/-/raw/fe047f301f0c384ad0668a73dfe776d9ac482d0f/galaxy_tool/test-data/odv_collection.txt"/>
@@ -131,8 +134,9 @@
131134
</conditional>
132135
<output_collection name="nc_files" type="list" count="1"/>
133136
<output_collection name="csv_files" type="list" count="1"/>
137+
<output_collection name="log_files" type="list" count="3"/>
134138
</test>
135-
<test expect_num_outputs="2">
139+
<test expect_num_outputs="3">
136140
<param name="input_raw" location="https://gitlab.com/pokapok-projects/easy-qcv-bgc/qcv-bgc-tools/-/raw/fe047f301f0c384ad0668a73dfe776d9ac482d0f/galaxy_tool/test-data/QCV_harmonizer_NetCDF_data_0.nc"/>
137141
<param name="input_hist" location="https://gitlab.com/pokapok-projects/easy-qcv-bgc/qcv-bgc-tools/-/raw/fe047f301f0c384ad0668a73dfe776d9ac482d0f/galaxy_tool/test-data/history_from_odv_collection.txt"/>
138142
<param name="input_odv" location="https://gitlab.com/pokapok-projects/easy-qcv-bgc/qcv-bgc-tools/-/raw/fe047f301f0c384ad0668a73dfe776d9ac482d0f/galaxy_tool/test-data/odv_collection.txt"/>
@@ -143,6 +147,7 @@
143147
</conditional>
144148
<output_collection name="nc_files" type="list" count="1"/>
145149
<output_collection name="csv_files" type="list" count="1"/>
150+
<output_collection name="log_files" type="list" count="3"/>
146151
</test>
147152
</tests>
148153
<help><![CDATA[
@@ -152,12 +157,11 @@ ODV history manager
152157
153158
**What it does**
154159
155-
This tool present two type of actions :
156-
- history : the tool report in the input file the ODV history including the change of QC flag
160+
This tool reports in the input file (a netcdf from the QCV harmonizer tool or the BioGeoChemical calibration tool) the ODV history including the change of QC flag.
157161
158162
**Input description**
159163
160-
file_name_raw : nc file to be qualified
164+
file_name_raw : nc file to be qualified, this netcdf should come from the QCV harmonizer tool or from the BioGeoChemical calibration tool
161165
file_name_history : history txt file extracted from ODV (manualy or automatically)
162166
odv_collection$name : name of the odv collection view with webODV and updated
163167
odv_collection$qc_convention : tool makes mapping when its necessary and when global attribute qc_convention is available and filled in file_name_raw

0 commit comments

Comments
 (0)