fim_process_unit_wb.sh

#!/bin/bash -e

:
usage ()
{
    echo "
    Why is this file here and it appears to be using duplicate export variables?
    For portability, we can make a direct call to this file with two parameters: HUC Number & Run Name;
    which correspond to the -n argument in fim_pipeline.sh and fim_pre_processing.sh.

    This file will catch any and all errors from src/run_unit_wb.sh, even if that script aborts.

    It is not possible to call src/run_unit_wb.sh directly, as it relies on exported values from this file.
        src/run_unit_wb.sh will futher process branches (src/process_branch.sh) in parallel.

    Usage: ./fim_process_unit_wb.sh <name_of_your_run> <huc8>

    Produce FIM hydrofabric datasets for a single unit and branch scale.
    - Note: fim_pre_processing.sh must have been already run. This script does
        not include post processing (see fim_pipeline.sh).
        Only a single HUC and its branches will be processed.

    Arguments:
        1) run name
        2) HUC number
            Example:

                ./fim_process_unit_wb.sh test_name 05030104
    "
    exit
}

# print usage if agrument is '-h' or '--help'
if [ "$1" = "-h" ] || [ "$1" = "--help" ]; then
    usage
fi

export runName=$1
export hucNumber=$2


# print usage if arguments empty
if [ "$runName" = "" ]
then
    echo "ERROR: Missing run time name argument (1st argument)"
    usage
fi

if [ "$hucNumber" = "" ]
then
    echo "ERROR: Missing hucNumber argument (2nd argument)"
    usage
fi

re='^[0-9]+$'
if ! [[ $hucNumber =~ $re ]] ; then
   echo "Error: hucNumber is not a number" >&2; exit 1
   usage
fi

echo "=========================================================================="
echo "---- Start of huc processing for $hucNumber"


# outputsDir, srcDir, workDir and others come from the Dockerfile
export tempRunDir=$workDir/$runName
export outputDestDir=$outputsDir/$runName
export tempHucDataDir=$tempRunDir/$hucNumber
export outputHucDataDir=$outputDestDir/$hucNumber
export tempBranchDataDir=$tempHucDataDir/branches
export current_branch_id=0

## huc data
if [ -d "$outputHucDataDir" ]; then
    rm -rf $outputHucDataDir
fi

# make outputs directory
mkdir -p $tempHucDataDir
mkdir -p $tempBranchDataDir

# Clean out previous unit logs and branch logs starting with this huc
rm -f $outputDestDir/logs/unit/"$hucNumber"_unit.log
rm -f $outputDestDir/logs/branch/"$hucNumber"_summary_branch.log
rm -f $outputDestDir/logs/branch/"$hucNumber"*.log
rm -f $outputDestDir/unit_errors/"$hucNumber"*.log
rm -f $outputDestDir/branch_errors/"$hucNumber"*.log

hucLogFileName=$outputDestDir/logs/unit/"$hucNumber"_unit.log

# Process the actual huc
/usr/bin/time -v $srcDir/run_unit_wb.sh 2>&1 | tee $hucLogFileName

#exit ${PIPESTATUS[0]} (and yes.. there can be more than one)
# and yes.. we can not use the $? as we are messing with exit codes
return_codes=( "${PIPESTATUS[@]}" )

# we do this way instead of working directly with stderr and stdout
# as they were messing with output logs which we always want.
err_exists=0
for code in "${return_codes[@]}"
do
    # Make an extra copy of the unit log into a new folder.

    # Note: It was tricky to load in the fim_enum into bash, so we will just
    # go with the exit code for now
    if [ $code -eq 0 ]; then
        echo
        # do nothing
    elif [ $code -eq 60 ]; then
        echo
        echo "***** Unit has no valid branches *****"
        err_exists=1
    elif [ $code -eq 61 ]; then
        echo
        echo "***** Unit has no remaining valid flowlines *****"
        err_exists=1
    else
        echo
        echo "***** An error has occured  *****"
        err_exists=1
    fi
done

if [ "$err_exists" = "1" ]; then
    # copy the error log over to the unit_errors folder to better isolate it
    cp $hucLogFileName $outputDestDir/unit_errors
fi

# Move the contents of the temp directory into the outputs directory and update file permissions
mv -f $tempHucDataDir $outputHucDataDir
find $outputHucDataDir -type d -exec chmod -R 777 {} +

echo "============================================================================================="
echo
echo "***** Moved temp directory: $tempHucDataDir to output directory: $outputHucDataDir  *****"
echo
echo "============================================================================================="

# we always return a success at this point (so we don't stop the loops / iterator)
exit 0