annotate bgc_harmonizer.xml @ 1:f10c3f6ee575 draft

planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/bgc_ocean commit d39442c4f2ee63f6f33f8aef5e6ac2f9d0c7bb3a

<tool id="harmonize_insitu_to_netcdf" name="QCV harmonizer" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="22.01" license="MIT">
    <description>and aggregator of in-situ marine physical and biogeochemical data</description>
    <macros>
        <token name="@TOOL_VERSION@">2.0</token>
        <token name="@VERSION_SUFFIX@">0</token>
    </macros>
    <requirements>
        <container type="docker">pokapok/qcv_ingester:@TOOL_VERSION@</container>
    </requirements>
    <command detect_errors="exit_code"><![CDATA[
        export HOME=\$PWD &&

        #for $i, $infile in enumerate($infiles):
            cp '$infile' '/runtime/data-in/${infile.element_identifier}' &&
        #end for

        /app/launchers/start-app.sh GALAXY &&
        
        cp /runtime/data-out/*.nc '$output_net'
    ]]></command>
    <inputs>
        <param name="infiles" type="data" format="netcdf" multiple="true" label="Input the NetCDF data files" help="This files can NetCDF raw Argo or Gliders data files following CMEMS convention."/>
    </inputs>
    <outputs>
        <data name="output_net" format="netcdf" label="${tool.name} NetCDF data" />
    </outputs>
    <tests>
        <test expect_num_outputs="1">
            <param name="infiles" value="D6901758_001.nc,D6901758_002.nc,D6901758_003.nc,D6901758_004.nc,D6901758_005.nc"/>
            <output name="output_net">
                <assert_contents>
            	    <has_size value="480666" delta="0"/>
            	</assert_contents>
            </output>
        </test>
    </tests>
    <help><![CDATA[

.. class:: infomark

**What it does**
General presentation

The cerb_harmonizer tool aggregates and harmonizes marine in-situ data following the needs of the UseCase 2.1-BCG - Fair-Ease. It converts files of individual or already aggregated data profiles into concatened single file with harmonized vocabullary needed for the project.
Profiles are concatenated along the time dimension in the order given by the lising : if BGC data preceed CORE profiles, all BGC data will preceed CORE data. Use cycle_number variable to associate them again.
Vocabulary translations are below. On the left, the writing of each variable in the output file, on the right, all possible translations found over data exploration.

Coordinates and variables :

    "lon" : ["longitude", "LONGITUDE", "LON", "lon"],
    "lat" : ["latitude", "LATITUDE", "LAT", "lat"],
    "time" : ["date", "time", "TIME", "JULD"],
    "time_qc" : ["date_qc", "time_qc", "TIME_QC", "JULD_QC"],
    "depth" : ["DEPTH", "depth"],
    "cycle_number" : ["CYCLE_NUMBER"],
    "ref_time" : ["REFERENCE_DATE_TIME"],
    "pos_qc" : ["POSITION_QC",]

--

    "temperature" : ["TEMP", "TEMPERATURE", "t_an"],
    "salinity" : ["PSAL", "PRACTICAL_SALINITY", "s_an"],
    "oxygen" : ["DOXY", "o_an"],
    "oxygenSat" : ["O_an"],
    "pressure" : ["PRES"],
    "chlorophylle" : ["CHLA"],
    "nitrate" : ["NO3", "NITRATE", "n_an"],
    "bbp700" : ["BBP700"],
    "C1PHASE_DOXY" : ["C1PHASE_DOXY"],
    "C2PHASE_DOXY" : ["C2PHASE_DOXY"],
    "TEMP_DOXY" : ["TEMP_DOXY"],

All variables are tagged with a suffix to indicate the state of the data (_raw, _dmadjusted, _rtadjusted)

--

Variables extracted from meta files are :

    LAUNCH_DATE
    PLATFORM_TYPE
    PI_NAME meta variables are stored as metadata

--

Units :

    "degree_east" : ["degree_east"],
    "degree_north" : ["degree_north"],
    "degree_celsius" : ["degree_celsius", "degree_Celsius"], # temperature
    "psu" : ["psu", "practical_salinity_unit", "PSU"], # salinity
    "micromol/l" : ["micromole.l-1", "micromole_per_liter", "μmol.l-1", "μmol/l", "μmol/L", "μmol.L-1"], # concentration liters
    "mg/m3" : ["mg/m3",],
    "micromole/kg" : ["micromole/kg",],
    "m-1" : ["m-1"],
    "decibar" : ["decibar", "dbar"], # pressure

Arbitrarily,

    dates are written following: "days decimal since 1950-01-01T00:00:00 in julian calendar"
    longitude is set between: -180° and 180°
    latitude is set between: -90° and 90°

WARNING: This application works only platform by platform. For example, it is possible to aggregate and harmonize a whole argo trajectory but one at a time.
         If two argo trajectories are needed to process, this tool needs to be run 2 times.

**Input**

files in the input folder should be like:

BD6901580_003.nc BD6901580_004.nc BD6901580_005.nc BD6901580_006.nc D6901580_003.nc D6901580_004.nc D6901580_005.nc D6901580_006.nc 6901580_meta.nc

**Output**

A concatenated and harmonized NetCDF file.

    ]]></help>
    <citations>
        <citation type="bibtex">
            @Manual{,
            title = {QCV Ingester},
            author = {Pokapok},
            year = {2024},
            note = {https://gitlab.com/pokapok-projects/PKP8-OGI-BGC/qcv_ingester}
        </citation>    
    </citations>
</tool>