Skip to content

Commit

Permalink
Update usage docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
truth-quark committed Oct 9, 2024
1 parent 998a3e3 commit ac58541
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions integration/binary_diff.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,22 @@
# between Martix Dix's base script & changes introduced by the
# um2nc-standalone development effort.
#
# NB: will display some um2nc output
# TODO: add larger inputs with more vars to the testing?
#
# This script warns if there is a binary difference comparing netCDF files
#
# TODO: add larger inputs with more vars to the testing?
# Terminal session setup
# $ export UM2NC_PROJ=<um2nc-standalone git dir>
# $ export UM2NC_TEST_DATA=<dir with test netCDFs>
#
# Usage:
# cd <um2nc-standalone git dir>
# ./integration/binary_diff.sh
#
# NB: will display some um2nc output
#
# Script warns if there is a binary difference comparing netCDF files
# If debugging a diff, the original source netCDF & the um2nc dev netCDF
# can be converted to text with `ncks` & compared with a diff tool.

echo "Binary equivalence/backwards compatibility diff for um2nc-standalone"

Expand Down

0 comments on commit ac58541

Please sign in to comment.