├── makefile ├── README.md ├── process_ghrsst.csh ├── add_time ├── LICENSE └── ghrsst-to-intermediate.f90 /makefile: -------------------------------------------------------------------------------- 1 | FC = pgf90 2 | FFLAGS = -g 3 | FFLAGS += -tp=istanbul 4 | FFLAGS += -mcmodel=medium 5 | #FFLAGS += -Kieee # use exact IEEE math 6 | FFLAGS += -Mbounds # for bounds checking/debugging 7 | #FFLAGS += -Ktrap=fp # trap floating point exceptions 8 | FFLAGS += -Bstatic_pgi # to use static PGI libraries 9 | #FFLAGS += -Bstatic # to use static netCDF libraries 10 | FFLAGS += -mp=nonuma -nomp # fix for "can't find libnuma.so" 11 | 12 | # NETCDF should be compiled with the same compiler as this program 13 | 14 | #NETCDF = /usr/local/src/wrf/LIBS 15 | #HDF5 = /usr/local/src/hdf5-1.8.20.pgi 16 | INCL = -I$(NETCDF)/include 17 | INCL += -I$(HDF5)/include 18 | LIBS = -L$(NETCDF)/lib -lnetcdf -lnetcdff 19 | LIBS += -L$(HDF5)/lib -lhdf5_hl -lhdf5 -lm 20 | LIBS += -L/usr/lib64 -lz -ldl 21 | 22 | PROGRAM = ghrsst-to-intermediate 23 | SOURCES = ghrsst-to-intermediate.f90 24 | OBJECTS = $(SOURCES:.f90=.o) 25 | 26 | TODAY = 2020-04-16 27 | VERSION = 1.0 28 | 29 | $(PROGRAM): $(OBJECTS) 30 | $(FC) $(FFLAGS) $(OBJECTS) $(LIBS) -o $@ 31 | 32 | %.o : %.f90 33 | $(FC) $(FFLAGS) $(INCL) -c $< -o $@ 34 | 35 | install: $(PROGRAM) 36 | cp $(PROGRAM) /usr/local/bin 37 | 38 | distro: 39 | zip $(PROGRAM)_v$(VERSION)_$(TODAY).zip \ 40 | $(SOURCES) *.csh add_time makefile README.txt 41 | 42 | clean: 43 | rm $(PROGRAM) $(OBJECTS) 44 | 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # WPS-ghrsst-to-intermediate 2 | Converts JPL PODAAC GHRSST netCDF files to WPS Intermediate version 5 files 3 | 4 | This program is designed to replace running WPS's ungrib program on an 5 | SST dataset. It works on the netCDF files from the GDS version 2 6 | GHRSST datasets available at the JPL PODAAC: 7 | 8 | https://podaac.jpl.nasa.gov/datasetlist?ids=ProcessingLevel&values=*4*&search=GHRSST&view=list 9 | 10 | This program may also work on GHRSST datasets that don't have 11 | "GDS version 2" in the name. If you try it and it works, or have some 12 | code changes that make it work, please let me know. 13 | 14 | There are both global and local GHRSST datasets. 15 | 16 | If your chosen dataset is local, and some of your WRF domains are 17 | outside of the GHRSST data coverage area, then you'll want to retain 18 | the SST fields in whatever other datasets you're using for the rest of 19 | the required inputs to WRF. 20 | 21 | If your chosen dataset is global, then you may optionally NOT ungrib the 22 | SST fields from whatever other datasets you're using for the rest of the 23 | required intput to WRF. Do that by eliminating the line containing 24 | "SST" from the Vtable: 25 | sed -i '/\/d' Vtable 26 | 27 | Type "ghrsst-to-intermediate --help" for usage. 28 | 29 | Pass a text file with a list of path/to/GHRSST_files, one per line, to 30 | "process_ghrsst.csh" to convert all the GHRSST files in the list, and 31 | interpolate to the value of interval_seconds grepped from 32 | namelist.wps. It also assumes the file (or a link to) geo_em.d01.nc in 33 | the current directory, to extract the minimum domain in the 34 | SST:YYYY-MM-DD_HH files. I call the script from my WPS generator 35 | script. 36 | 37 | COMPILING 38 | 39 | A sample makefile is included, with some commented-out blocks for different 40 | compilers. 41 | 42 | I have one report that "integer, external" should be "integer, intrinsic" 43 | for gfortran (gcc). That's the only change to the *.f90 files you might 44 | need to make to compile the program. 45 | 46 | Bart Brashers 47 | bbrashers@ramboll.com 48 | 2020-06-02 49 | -------------------------------------------------------------------------------- /process_ghrsst.csh: -------------------------------------------------------------------------------- 1 | #!/bin/csh -f 2 | 3 | if ($#argv == 0 | "$1" =~ -*h*) then 4 | echo "Usage: $0:t filelist" 5 | echo "Processes a list of GHRSST files, one per line, by calling" 6 | echo "'ghrsst --sst -g geo_em.d01.nc file' on each, then calling" 7 | echo "interp-intermediate to interpolate to interval_seconds as" 8 | echo "found in namelist.wps in the current directory." 9 | echo "Designed to be run in a WPS runtime directory." 10 | exit 11 | endif 12 | 13 | if !(-e geo_em.d01.nc) then 14 | echo "Error: No geo_em.d01.nc file found. " 15 | echo "Edit this script to (pick one):" 16 | echo " 1. Remove the '-g geo_em.d01.nc' to process globally" 17 | echo " 2. Give a path to geo_em.d01.nc" 18 | echo " 3. Make a soft link (ls -s) to geo_em.d01.nc." 19 | exit 20 | endif 21 | 22 | if !(-e namelist.wps) then 23 | echo "Error: No namelist.wps file found. " 24 | echo "Edit this script to hard-code the time interval, instead of " 25 | echo "converting from interval_seconds grepped from namelist.wps." 26 | exit 27 | endif 28 | 29 | set verb = 0 # 0 = shut up, 1 = be verbose 30 | if ("$1" =~ -*v* | "$1" =~ -*d*) then # matches -v, --verbose, -d, --debug 31 | set verb = 1 32 | shift # get rid of -v 33 | endif 34 | 35 | set debug = "" 36 | if ($verb) set debug = "--debug " 37 | 38 | set ghrsst_files = (`cat $1`) 39 | 40 | foreach file ($ghrsst_files) 41 | if ($verb) echo "Converting $file" 42 | ghrsst-to-intermediate $debug --nolandsea --sst -g geo_em.d01.nc $file >>&! process_ghrsst.log 43 | end 44 | 45 | set files = (SST:*) # FIXME: this needs to be more general, to handle SST: and SEAICE: 46 | 47 | if ($verb) then 48 | echo "Done with ghrsst-to-intermediate, have these files:" 49 | ls -1 $files 50 | endif 51 | 52 | set interval_seconds = `grep interval_seconds namelist.wps | cut -d= -f2` 53 | set interval_hours = `echo "$interval_seconds / 3600" | bc` 54 | 55 | set param = `echo $files[1] | cut -d: -f1` # just SST from SST:YYYY-MM-DD_HH 56 | 57 | #set n = `echo "$#files - 1" | bc` # could use '@ n = $#files - 1' 58 | @ n = $#files - 1 59 | 60 | if ($verb) \ 61 | echo "Interpolating to $interval_hours hours between $#files files ($n calls)." 62 | 63 | foreach i (`seq 1 $n`) 64 | 65 | @ ip1 = $i + 1 66 | if ($verb) echo -n " Interval $i, " 67 | 68 | set time1 = `echo $files[$i] | cut -d: -f2` # starting and ending times 69 | set time2 = `echo $files[$ip1] | cut -d: -f2` # for these two files 70 | 71 | if ($verb) echo -n "between $time1 and $time2, " 72 | 73 | set now = `add_time -1 $time1 $interval_hours` # first output, YYYYMMDDHH 74 | set end2 = `add_time -1 $time2 0` # convert from YYYY-MM-DD_HH to YYYYMMDDHH 75 | 76 | if ($verb) echo "starting at $now, ending $end2" 77 | 78 | while ($now < $end2) # needs YYYYMMDDHH to loop correctly 79 | 80 | set timeOut = `add_time --wrf $now 0` # convert to YYYY-MM-DD_HH 81 | 82 | if ($verb) echo " Creating ${param}:$timeOut from $files[$i] and $files[$ip1]" 83 | interp-intermediate $debug -i $files[$i] $files[$ip1] -o ${param}:$timeOut 84 | echo Interpolated to create ${param}:$timeOut >>&! process_ghrsst.log 85 | 86 | set now = `add_time -1 $now $interval_hours` # YYYYMMDDHH 87 | 88 | end 89 | end 90 | -------------------------------------------------------------------------------- /add_time: -------------------------------------------------------------------------------- 1 | #!/bin/csh -f 2 | # 3 | if ($#argv == 0 | $1 =~ -*h*) then 4 | usage: 5 | echo "Usage: $0:t [Options] YearMoDyHr Delta | Year-Mo-Dy_hr Delta | Year Mo Dy Hr Delta | YearMoDy Delta" 6 | echo "Options:" 7 | echo " -24 make hours be 1-24 (default is 0-23)" 8 | echo " --wrf force output format to YYYY-MM-DD_HH (WRF/MM5 style)" 9 | echo " -1 force output format to YYYYMMDDHH (one word)" 10 | echo " -4 force output format to YYYY MM DD HH (four words)" 11 | echo " -8 force output format to YYYYMMDD (8 chars, no hour)" 12 | echo "" 13 | echo "Year, Mo, Dy and Hr are integers. Year can be 2 digits or 4 digits." 14 | echo "" 15 | echo "Delta is the amount of time to add (or subtract, if < 0) from the time-stamp." 16 | echo "Examples of valid Delta values: " 17 | echo " 1 add 1 hour" 18 | echo " -5 subtract 5 hours" 19 | echo " 5d12h add 5 days and 12 hours (same as 5d12)" 20 | echo " 3y5m2d1h add 3 years, 5 month, 2 days, and 1 hour" 21 | echo " 1y-1d add 1 year, then subtract 1 day" 22 | echo " -3m1d subtract 3 months, then add 1 day" 23 | echo " -3m-1d subtract 3 months, then subtract another day" 24 | echo "" 25 | echo "One can 'legalize' illegal time-stamps, by adding 0 hours to it:" 26 | echo " $0:t 2014_22_35_92 0 gives 2015-11-07_20" 27 | echo "" 28 | echo "One can change from hour = 0-23 to hour = 1-24 format:" 29 | echo " $0:t -4 -24 2008030100 0 gives 2008 02 29 24" 30 | echo "" 31 | echo "Adding months when starting with a time-stamp near the end of a month" 32 | echo "can give unexpected (though technically correct) results:" 33 | echo " $0:t 2014_08_31_12 1m gives 2014-10-01_12" 34 | echo " $0:t 2014_10_31_12 -1m gives 2014-10-01_12" 35 | echo "" 36 | echo "This is because September only has 30 days, so 2014-09-31_12 is really" 37 | echo "the next day. So when adding months, use dy = 1 and hr = 0." 38 | exit 39 | endif 40 | 41 | # Initialize some variables 42 | 43 | set yrs = 0 44 | set mos = 0 45 | set dys = 0 46 | set hrs = 0 47 | set maxhr = 23 48 | set style = 0 # 0 = same as input, 1 = YYYYMMDDHH, 2 = wrf-style, 4 = Y M D H 49 | set inputs = "" 50 | 51 | set iarg = 0 # index of command-line arguments 52 | while ($iarg < $#argv) 53 | @ iarg++ 54 | if ("$argv[$iarg]" == "-24") then 55 | set maxhr = 24 56 | else if ("$argv[$iarg]" == "-1") then 57 | set style = 1 # YYYYMMDDHH 58 | else if ("$argv[$iarg]" == "--wrf") then 59 | set style = 2 # YYYY-MM-DD_HH 60 | else if ("$argv[$iarg]" == "-4") then 61 | set style = 4 # YYYY MM DD HH 62 | else if ("$argv[$iarg]" == "-8") then 63 | set style = 8 # YYYYMMDD 64 | else 65 | set inputs = ($argv[$iarg-$#argv]) 66 | set iarg = $#argv # exit this while loop 67 | endif 68 | end 69 | 70 | set minhr = `echo $maxhr - 23 | bc` 71 | 72 | # Detect if user gave YYYYMMDD, i.e. no HH. There's no other valid 73 | # input that is 8 characters long, so it must be YYYYMMDD 74 | 75 | if ($%inputs[1] == 8) then 76 | set inputs = ($inputs[1]00 $inputs[2-]) 77 | endif 78 | 79 | # Detect if user gave YYYY-MM-DD, i.e. no _HH, and append _00 80 | 81 | set tmp = `echo $inputs[1] | cut -c5` # 5th char is -, so YYYY- 82 | if ($%inputs[1] == 10 & "$tmp" == "-") set inputs = ($inputs[1]_00 $inputs[2-]) 83 | 84 | if ($#inputs == 2) then # YYYYMMDDHH Delta 85 | 86 | set tmp = `echo $inputs[1] | grep _ >& /dev/null` 87 | if ($status == 0 & $style == 0) set style = 2 88 | if ($style == 0) set style = 1 # got YYYYMMDDHH, give same 89 | 90 | set timestamp = `echo $inputs[1] | tr -d "/_-"` 91 | if ($%timestamp > 8) then # four-digit year 92 | set year = `echo $timestamp | cut -c1-4` 93 | set month = `echo $timestamp | cut -c5-6` 94 | set day = `echo $timestamp | cut -c7-8` 95 | set hour = `echo $timestamp | cut -c9-10` 96 | else # 2-digit year 97 | set year = `echo $timestamp | cut -c1-2` 98 | set month = `echo $timestamp | cut -c3-4` 99 | set day = `echo $timestamp | cut -c5-6` 100 | set hour = `echo $timestamp | cut -c7-8` 101 | endif 102 | set delta = $inputs[2] 103 | 104 | else # gave YYYY MM DD HH delta 105 | 106 | if ($style == 0) set style = 4 # got YYYY MM DD HH, give same 107 | set year = $inputs[1] 108 | set month = $inputs[2] 109 | set day = $inputs[3] 110 | set hour = $inputs[4] 111 | set delta = $inputs[5] 112 | 113 | endif 114 | 115 | # Handle the case where delta is 5d (5 days) or 3h or 5d+3h or -5d-12h 116 | 117 | set din = `echo $delta | tr -d '+h'` # "delta-in" is din, get it? 118 | 119 | if ("$din" =~ *y*) then # there's a year, like 3y5d3h 120 | set yrs = `echo $din | cut -d y -f1` # whatever's before the "y" 121 | set din = `echo $din | cut -d y -f2` # remainder, like 5d3h 122 | endif 123 | 124 | if ("$din" =~ *m*) then # there's a month, like 3y2m5d3h 125 | set mos = `echo $din | cut -d m -f1` # whatever's before the "m" 126 | set din = `echo $din | cut -d m -f2` # remainder, like 5d3h 127 | endif 128 | 129 | if ("$din" =~ *d*) then # there's a day, like 5d3h 130 | set dys = `echo $din | cut -d d -f1` # whatever's before the "d" 131 | set din = `echo $din | cut -d d -f2` # what remains is hours 132 | endif 133 | 134 | if ($%din > 0) set hrs = $din # whatever's left 135 | 136 | #set din = `echo $delta | tr -d '+h'` # "delta-in" is din, get it? 137 | #set negative = 0 # false, default is adding time 138 | #if ("$din" =~ *-*) then # a negative in there somewhere 139 | # set negative = 1 # will pre-pend below 140 | # set din = `echo $din | tr -d -- -` 141 | #endif 142 | # 143 | #set delta = 0 # will be in hours 144 | # 145 | #if ("$din" =~ *y*) then # there's a year, like 3y5d3h 146 | # set yr = `echo $din | cut -d y -f1` # whatever's before the "y" 147 | # foreach y (`seq 1 $yr`) 148 | # set yr1 = $y 149 | # if ("$negative" == "-") set yr1 = `echo "$yr - 1" | bc` 150 | # set days = `julian -y ${yr1}1231` 151 | # set delta = `echo "$delta + $yr * 365 * 24" | bc` 152 | # end 153 | # set din = `echo $din | cut -d y -f2` # remainder, like 5d3h 154 | #endif 155 | # 156 | #if ("$din" =~ *d*) then # there's a day, like 5d3h 157 | # set dy = `echo $din | cut -d d -f1` 158 | # set delta = `echo "$delta + $dy * 24" | bc` 159 | # set din = `echo $din | cut -d d -f2` # what remains is hours 160 | #endif 161 | # 162 | #if ($%din > 0) set delta = `echo "$delta + $din" | bc` 163 | # 164 | #if ($negative) set delta = -$delta 165 | # 166 | # Tested this method, using "date +%s" to find seconds in epoch. 167 | # But it will not allow for hr to be range 1:24. Stick with old method. 168 | # 169 | #set strt = `date -d "$year-$month-$day $hour" +%s` 170 | #set delta = `echo "$delta * 3600" | bc` # date gives seconds since epoch 171 | #set endd = `echo $strt + $delta | bc` 172 | # 173 | #if ($style == 1) then 174 | # date -d @$endd +%Y%m%d%H 175 | #else if ($style == 2) then 176 | # date -d @$endd +%Y-%m-%d_%H 177 | #else if ($style == 4) then 178 | # date -d @$endd +"%Y %m %d %H" 179 | #endif 180 | #exit 181 | 182 | set daysinmonth = (31 28 31 30 31 30 31 31 30 31 30 31) 183 | if (`expr $year % 4` == 0) set daysinmonth[2] = 29 # leap year, Y2K compliant 184 | # 185 | set yr = `echo "$year + $yrs" | bc` 186 | set mo = `echo "$month + $mos" | bc` 187 | set dy = `echo "$day + $dys" | bc` 188 | set hr = `echo "$hour + $hrs" | bc` 189 | 190 | while ($mo > 12) # if adding just months 191 | set mo = `echo "$mo - 12" | bc` 192 | set yr = `echo "$yr + 1" | bc` 193 | end 194 | while ($mo < 1) # if subtracting just months 195 | set mo = `echo "$mo + 12" | bc` 196 | set yr = `echo "$yr - 1" | bc` 197 | end 198 | 199 | while ($dy > $daysinmonth[$mo]) # if adding just days 200 | set dy = `echo "$dy - $daysinmonth[$mo]" | bc` 201 | set mo = `echo "$mo + 1" | bc` 202 | while ($mo > 12) 203 | set mo = `echo "$mo - 12" | bc` 204 | set yr = `echo "$yr + 1" | bc` 205 | end 206 | end 207 | while ($dy < 1) # if subtracting just days 208 | set mo = `echo "$mo - 1" | bc` 209 | while ($mo < 1) 210 | set mo = `echo "$mo + 12" | bc` 211 | set yr = `echo "$yr - 1" | bc` 212 | end 213 | set dy = `echo "$dy + $daysinmonth[$mo]" | bc` 214 | end 215 | 216 | while ($hr > $maxhr) # if adding hours 217 | set hr = `echo "$hr - 24" | bc` 218 | set dy = `echo "$dy + 1" | bc` 219 | while ($dy > $daysinmonth[$mo]) 220 | set dy = `echo "$dy - $daysinmonth[$mo]" | bc` 221 | set mo = `echo "$mo + 1" | bc` 222 | while ($mo > 12) 223 | set mo = `echo "$mo - 12" | bc` 224 | set yr = `echo "$yr + 1" | bc` 225 | end 226 | end 227 | end 228 | while ($hr < $minhr) # if subtracting hours 229 | set hr = `echo "$hr + 24" | bc` 230 | set dy = `echo "$dy - 1" | bc` 231 | while ($dy < 1) 232 | set mo = `echo "$mo - 1" | bc` 233 | while ($mo < 1) 234 | set mo = `echo "$mo + 12" | bc` 235 | set yr = `echo "$yr - 1" | bc` 236 | end 237 | set dy = `echo "$dy + $daysinmonth[$mo]" | bc` 238 | end 239 | end 240 | 241 | if ($%yr == 1) set yr = 0$yr # make sure output is (at least) 2 digits 242 | if ($%mo == 1) set mo = 0$mo 243 | if ($%dy == 1) set dy = 0$dy 244 | if ($%hr == 1) set hr = 0$hr 245 | 246 | if ($style == 0) then 247 | echo "Couldn't determine output style. Shouldn't happen..." 248 | else if ($style == 1) then # YYYYMMDDHH 249 | echo $yr$mo$dy$hr 250 | else if ($style == 2) then # wrf style 251 | echo $yr-$mo-${dy}_$hr 252 | else if ($style == 4) then # wrf style 253 | echo $yr $mo $dy $hr 254 | else if ($style == 8) then # YYYYMMDD no hour 255 | echo $yr$mo$dy 256 | endif 257 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /ghrsst-to-intermediate.f90: -------------------------------------------------------------------------------- 1 | program ghrsst_to_intermediate 2 | !------------------------------------------------------------------------------ 3 | ! Written by Bart Brashers, Ramboll, bbrashers@ramboll.com. 4 | ! Last update: 2020-06-02 version 1.3 5 | ! Converts the data found at 6 | ! https://podaac-opendap.jpl.nasa.gov/opendap/allData/ghrsst/data/GDS2/L4/GLOB/JPL/MUR/v4.1/ 7 | ! https://podaac-opendap.jpl.nasa.gov/opendap/allData/ghrsst/data/L4/GLOB/JPL_OUROCEAN/G1SST/ 8 | ! (and probably many more of their GHRSST datasets) 9 | ! to WPS intermediate format (metgrid-ready format). 10 | ! See 11 | ! https://podaac-tools.jpl.nasa.gov/drive/files/OceanTemperature/ghrsst/docs/GDS20r5.pdf 12 | ! https://podaac.jpl.nasa.gov/datasetlist?ids=ProcessingLevel&values=*4*&search=GHRSST&view=list 13 | ! https://podaac.jpl.nasa.gov/dataset/JPL_OUROCEAN-L4UHfnd-GLOB-G1SST 14 | ! https://podaac.jpl.nasa.gov/dataset/MUR-JPL-L4-GLOB-v4.1 15 | ! 16 | !---------------------------------------------------------------------- 17 | ! This program is free software, using GNU General Public License v3.0. 18 | ! See the file COPYING, or https://www.gnu.org/licenses/gpl-3.0.en.html 19 | !---------------------------------------------------------------------- 20 | 21 | implicit none 22 | include 'netcdf.inc' 23 | 24 | logical :: wind_grid_rel = .false. ! Flag indicating whether winds are 25 | ! relative to source grid (TRUE) or 26 | ! relative to earth (FALSE) 27 | logical :: debug = .false. ! set to .true. to debug 28 | logical :: write_sst = .false. ! Flag to output SST:YYYY-MM-DD_HH files 29 | logical :: write_ice = .false. ! Flag to output SST:YYYY-MM-DD_HH files 30 | logical :: write_landsea = .false. ! Flag to output LANDSEA:YYYY-MM-DD_HH files 31 | logical :: append_landsea = .true. ! Flag to append the LANDSEA to SST: and ICE: 32 | logical :: crosses_180E = .false. ! Flag that the WRF domain crosses lon = 180 33 | ! integer, intrinsic :: iargc ! gfortran understands this 34 | integer, external :: iargc ! pgfortran understands this 35 | integer :: iarg ! arguement index 36 | integer, parameter :: version = 5 ! Format version (must =5 for WPS format) 37 | integer, parameter :: iProj = 0 ! Projection type is lat-lon 38 | integer :: nx,ny ! size of the array 39 | integer :: bad_value ! ncfile's bad value flag 40 | integer :: year,month,day,hour,jday ! time-related 41 | integer :: ibeg,iend,jbeg,jend ! output sub-domain range 42 | integer :: imid ! the "middle" of i-range, lons 43 | integer :: i,j,rcode, ivtype 44 | integer :: cdfid, id, ndims,natts, idims(10),dimids(10) 45 | integer :: istart1,iend1, istart(3),istop(3) 46 | integer :: geoflag ! 0 = none, 1 = geo_em given, 2 = bounds given 47 | 48 | integer (kind=2), allocatable, dimension(:,:) :: sst_in ! 16-bit signed integer 49 | integer (kind=1), allocatable, dimension(:,:) :: ice_in ! 8-bit integer (byte) 50 | integer (kind=1), allocatable, dimension(:,:) :: mask_in ! 8-bit integer (byte) 51 | real, allocatable, dimension(:,:) :: sst ! output (scaled) SST 52 | real, allocatable, dimension(:,:) :: ice ! output (scaled) sea ice fraction 53 | real, allocatable, dimension(:,:) :: landsea ! output land-sea mask 54 | real, allocatable, dimension(:,:) :: landseaice ! output land-seaice mask 55 | real, allocatable, dimension(:) :: lats,lons ! output locs, 1D vectors 56 | real, allocatable, dimension(:) :: my_temp1d ! for re-shaping 57 | real, allocatable, dimension(:,:) :: my_temp2d ! for re-shaping 58 | real, allocatable, dimension(:,:) :: lat2d,lon2d ! geo_em XLAT_V,XLONG_U 59 | 60 | real, parameter :: bad = -1.e+30 ! value found in FILE:* from NAM12 61 | real, parameter :: earth_radius = 6371. 62 | real, parameter :: tlat1 = 0. ! not used for iProj = 0 (lat-lon) 63 | real, parameter :: tlat2 = 0. ! not used for iProj = 0 (lat-lon) 64 | real, parameter :: xlonc = 0. ! only used form iProj = 3 (LCC) or 5 (PS) 65 | real :: add_offset, scale_factor ! to convert sst_in (int) to sst (real) 66 | real :: valid_min, valid_max ! check range returned from NC file 67 | 68 | ! The variables needed to sub-set output using geo_em.d01.nc: 69 | 70 | real, dimension(16) :: corner_lats, corner_lons ! geo_em global attributes 71 | real :: min_lat, max_lat, min_lon, max_lon 72 | real :: sw_lon, nw_lon, se_lon, ne_lon 73 | 74 | ! The variables needed to write in WPS intermediate file format: 75 | 76 | real :: nlats ! Number of latitudes north of equator 77 | real :: xfcst ! Forecast hour of data 78 | real :: xlvl ! Vertical level of data in 2-d array 79 | real :: startlat, startlon ! Lat/lon of point in array of startloc 80 | real :: deltalat, deltalon ! Grid spacing, degrees 81 | real :: dx, dy ! Grid spacing, km 82 | 83 | character (len=80) :: varnam ! returned variable name from NC file 84 | character (len=8) :: startloc ! Which point in array is given by 85 | ! startlat/startlon; set either 86 | ! to 'SWCORNER' or 'CENTER ' 87 | character (len=9) :: field ! Name of the field 88 | character (len=10) :: date_str ! "YYYY-MM-DD" 89 | character (len=12) :: time_str ! "HH:mm:ss UTC" 90 | character (len=50) :: res_str ! resolution description 91 | character (len=24) :: hdate ! Valid date for data YYYY:MM:DD_HH:00:00 92 | character (len=25) :: units ! Units of data 93 | character (len=32) :: map_source ! Source model / originating center 94 | character (len=46) :: desc ! Short description of data 95 | character (len=256) :: ncfile ! input netCDF file downloaded from PODAAC 96 | character (len=256) :: geofile ! output from WPS' geogrid.exe (outer domain) 97 | character (len=256) :: arg,filename ! temporary storage 98 | character (len=100) :: prog_version ! 99 | 100 | !----Set defaults 101 | 102 | geoflag = 0 ! default to no geo_em or bounds specified 103 | prog_version = "ghrsst_to_intermediate-0.2" 104 | 105 | !----Process the command line 106 | 107 | if (iargc() == 0) call usage 108 | iarg = 0 109 | do while (iarg < iargc()) 110 | iarg = iarg + 1 111 | call getarg(iarg,arg) 112 | if (arg == '-h' .or. arg == '--help') then 113 | call usage 114 | else if (arg == '-d' .or. arg == '--debug') then 115 | debug = .true. 116 | write(*,*) "Debug mode turned on." 117 | else if (arg == '-V' .or. arg == '--version') then 118 | write(*,*) prog_version 119 | stop 120 | else if (arg == '-s' .or. arg == '--sst') then 121 | write_sst = .true. 122 | else if (arg == '-i' .or. arg == '--seaice') then 123 | write_ice = .true. 124 | else if (arg == '-l' .or. arg == '--landsea') then 125 | write_landsea = .true. 126 | else if (arg == '-n' .or. arg == '--nolandsea') then 127 | append_landsea = .false. 128 | else if (arg == '-g') then 129 | iarg = iarg + 1 130 | call getarg(iarg,geofile) 131 | geoflag = 1 ! a geo_em.nc file was given 132 | else if (arg == '-b') then 133 | iarg = iarg + 1 134 | call getarg(iarg,arg) 135 | read(arg,*) min_lat,max_lat,min_lon,max_lon 136 | min_lat = floor(min_lat) ; max_lat = ceiling(max_lat) ! round 137 | min_lon = floor(min_lon) ; max_lon = ceiling(max_lon) ! up/down 138 | geoflag = 2 ! bounds were given 139 | else 140 | call getarg(iarg,ncfile) 141 | endif 142 | end do 143 | 144 | if ((.not. write_sst) .and. (.not. write_ice) .and. (.not. write_landsea)) then 145 | write(*,*) 146 | write(*,*) "No outputs requested, nothing to do, quitting." 147 | write(*,*) "Specify one of -s|--sst, -i|--ice, or -l|--landsea." 148 | write(*,*) 149 | call usage ! calls stop 150 | endif 151 | 152 | ! Process the geo_em.d01.nc file, to find the domain extents by taking the 153 | ! minval and maxval of XLAT_V and XLONG_U. Check the cornerns of the domain 154 | ! to detect if the WRF domain spans lon = 180. 155 | 156 | if (geoflag == 1) then 157 | 158 | rcode = nf_open(geofile,NF_NOWRITE,cdfid) 159 | if (rcode == 0) then 160 | if (debug) write(*,*) 'Open geo_em file ',trim(geofile) 161 | else 162 | write(*,*) 'Error openiing geo_em file ',trim(geofile) 163 | stop 164 | end if 165 | 166 | rcode = nf_inq_dimid(cdfid,'west_east',id) 167 | rcode = nf_inq_dimlen(cdfid,id,nx) 168 | 169 | rcode = nf_inq_dimid(cdfid,'south_north',id) 170 | rcode = nf_inq_dimlen(cdfid,id,ny) 171 | 172 | allocate( lat2d(nx,ny+1), lon2d(nx+1,ny) ) 173 | 174 | call get_var_2d_real_cdf(cdfid,'XLAT_V', lat2d,nx,ny+1,1,debug) 175 | call get_var_2d_real_cdf(cdfid,'XLONG_U',lon2d,nx+1,ny,1,debug) 176 | rcode = nf_get_att_real(cdfid,nf_global,'corner_lons',corner_lons) 177 | rcode = nf_close(cdfid) ! done with the geo_em.d01.nc file 178 | 179 | ! We need to detect if the geo_em domain crosses the dateline (180E). 180 | ! See http://www.mmm.ucar.edu/wrf/users/docs/user_guide_V3/users_guide_chap3.htm 181 | ! and search down for "global attributes corner_lats and corner_lons" 182 | 183 | sw_lon = corner_lons(13) ! just easier to read 184 | nw_lon = corner_lons(14) 185 | ne_lon = corner_lons(15) 186 | se_lon = corner_lons(16) 187 | 188 | if (debug) then 189 | write(*,*) "Corners of geo_em file:" 190 | write(*,*) "sw_lon = ",sw_lon 191 | write(*,*) "nw_lon = ",nw_lon 192 | write(*,*) "ne_lon = ",ne_lon 193 | write(*,*) "se_lon = ",se_lon 194 | end if 195 | 196 | ! Handle the case of WRF domain crossing lon = 180 by changing lon range from 197 | ! -180:180 to 0:360. If lon < 0, add 360. And we'll have to re-build the 198 | ! data from the GHRSST file. 199 | 200 | if (any((/ & 201 | sw_lon > se_lon, & 202 | sw_lon > ne_lon, & 203 | nw_lon > se_lon, & 204 | nw_lon > ne_lon /))) then 205 | 206 | crosses_180E = .true. 207 | if (debug) write(*,*) "geo_em domain crosses the line lon = +/-180" 208 | 209 | if (sw_lon < 0.) sw_lon = sw_lon + 360. 210 | if (nw_lon < 0.) nw_lon = nw_lon + 360. 211 | if (se_lon < 0.) se_lon = se_lon + 360. 212 | if (ne_lon < 0.) ne_lon = ne_lon + 360. 213 | 214 | where (lon2d < 0.) lon2d = lon2d + 360. 215 | 216 | endif 217 | 218 | min_lat = minval(lat2d) 219 | max_lat = maxval(lat2d) 220 | min_lon = minval(lon2d) 221 | max_lon = maxval(lon2d) 222 | 223 | deallocate( lat2d, lon2d ) ! Done with these 224 | 225 | if (debug) then 226 | write(*,*) "Initial sub-domain:" 227 | write(*,*) "min_lat = ",min_lat 228 | write(*,*) "max_lat = ",max_lat 229 | write(*,*) "min_lon = ",min_lon 230 | write(*,*) "max_lon = ",max_lon 231 | endif 232 | 233 | ! Add a buffer of 0.5 degrees (lat or lon) to make sure we have enough data coverage. 234 | ! And round up/down to the nearest integer 235 | 236 | min_lon = real( floor(min_lon - 0.5)) 237 | max_lon = real(ceiling(max_lon + 0.5)) 238 | min_lat = real( floor(min_lat - 0.5)) 239 | max_lat = real(ceiling(max_lat + 0.5)) 240 | 241 | if (min_lat < -90.) min_lat = -90. ! range check 242 | if (max_lat > 90.) max_lat = 90. 243 | if (crosses_180E) then 244 | if (min_lon < 0.) min_lon = 0. 245 | if (max_lon > 360.) max_lon = 360. 246 | else 247 | if (min_lon < -180.) min_lon = -180. 248 | if (max_lon > 180.) max_lon = 180. 249 | endif 250 | 251 | if (debug) then 252 | write(*,*) "Extended/rounded sub-domain:" 253 | write(*,*) "min_lat = ",min_lat 254 | write(*,*) "max_lat = ",max_lat 255 | write(*,*) "min_lon = ",min_lon 256 | write(*,*) "max_lon = ",max_lon 257 | write(*,*) "sw_lon = ",sw_lon 258 | write(*,*) "nw_lon = ",nw_lon 259 | write(*,*) "ne_lon = ",ne_lon 260 | write(*,*) "se_lon = ",se_lon 261 | end if 262 | 263 | elseif (geoflag == 2) then ! user specified a lat-lon range 264 | 265 | ! Handle the case of WRF domain crossing lon = 180 by changing lon range from 266 | ! -180:180 to 0:360. If lon < 0, add 360. And we'll have to re-build the 267 | ! data from the GHRSST file. 268 | ! *** FIXME: this is un-tested! 269 | 270 | if ( min_lon > max_lon) then 271 | 272 | crosses_180E = .true. 273 | 274 | if (min_lon < 0.) min_lon = min_lon + 360. 275 | if (max_lon < 0.) max_lon = max_lon + 360. 276 | 277 | where (lon2d < 0.) lon2d = lon2d + 360. 278 | 279 | if (debug) then 280 | write(*,*) "Requested lat-lon box crosses the line lon = +/-180" 281 | write(*,*) "Revised output sub-domain:" 282 | write(*,*) "min_lat = ",min_lat 283 | write(*,*) "max_lat = ",max_lat 284 | write(*,*) "min_lon = ",min_lon 285 | write(*,*) "max_lon = ",max_lon 286 | endif 287 | 288 | endif 289 | 290 | end if ! if (geoflag == 1) then 291 | 292 | !***************************************************************************** 293 | ! Open the PODAAC GHRSST netCDF file 294 | !***************************************************************************** 295 | 296 | rcode = nf_open(ncfile,NF_NOWRITE,cdfid) 297 | if (rcode == 0) then 298 | if (debug) write(*,*) 'Opened netcdf file ',trim(ncfile) 299 | else 300 | write(*,*) 'Error ',rcode,'opening netcdf file ',trim(ncfile) 301 | stop 302 | end if 303 | 304 | !***************************************************************************** 305 | ! Get the Global Attributes we need 306 | !***************************************************************************** 307 | 308 | rcode = nf_get_att_text(cdfid,NF_GLOBAL,"start_time",time_str) ! eg "20190101T090000Z" 309 | read(time_str,'(i4,i2,i2)') year,month,day 310 | hour = 12 ! middle of the day, even though GHRSST default is 09 311 | write(hdate,'(i4.4,"-",i2.2,"-",i2.2,"_",i2.2,":00:00")') year,month,day,hour 312 | 313 | ! Get dimensions we need, and allocate only required arrays 314 | 315 | rcode = nf_inq_dimid(cdfid,'lat',id) 316 | rcode = nf_inq_dimlen(cdfid,id,ny) 317 | 318 | rcode = nf_inq_dimid(cdfid,'lon',id) 319 | rcode = nf_inq_dimlen(cdfid,id,nx) 320 | 321 | if (debug) write(*,*) "Allocating for nx,ny = ",nx,ny 322 | allocate( lats(ny), lons(nx)) 323 | if (crosses_180E) allocate( my_temp1d(nx), my_temp2d(nx,ny) ) 324 | 325 | ! Get the 1D vector of values for lat 326 | 327 | rcode = nf_inq_varid(cdfid,'lat',id) 328 | rcode = nf_inq_var(cdfid,id,varnam,ivtype,ndims,dimids,natts) 329 | if (debug) write(*,*) 'ID, Number of dims for lat ',id, ndims 330 | rcode = nf_get_vara_real(cdfid,id,1,ny,lats) 331 | 332 | ! Get the 1D vector of values for lon 333 | 334 | rcode = nf_inq_varid(cdfid,'lon',id) 335 | rcode = nf_inq_var(cdfid,id,varnam,ivtype,ndims,dimids,natts) 336 | if (debug) write(*,*) 'ID, Number of dims for lon ',id, ndims 337 | rcode = nf_get_vara_real(cdfid,id,1,nx,lons) 338 | 339 | if (crosses_180E) then ! swap the left & right halves of the array 340 | 341 | if (debug) write(*,*) "Output domain crosses lon=180E line, rearranging array." 342 | 343 | imid = nx/2+1 344 | if (debug) write(*,*) "1, nx-imid+1, imid, nx = ", 1, nx-imid+1, imid, nx 345 | 346 | ! Copy the right half, imid:nx, to the left half. 347 | ! Copy the left half, 1:nx-imid+1, to the right half. 348 | 349 | my_temp1d(1:(nx-imid+1)) = lons(imid:nx) 350 | my_temp1d(imid:nx) = lons(1:(nx-imid+1)) 351 | lons = my_temp1d 352 | where (lons <= 0.) lons = lons + 360. 353 | 354 | endif 355 | 356 | !***************************************************************************** 357 | ! Get the 2D grid of values for LANDSEA MASK 358 | ! Make one mask for land vs sea (for SST), and one for land/ice vs sea (for SEAICE) 359 | !***************************************************************************** 360 | 361 | if (write_landsea .or. append_landsea) then 362 | 363 | allocate( mask_in(nx,ny) ) 364 | 365 | rcode = nf_inq_varid(cdfid,'mask',id) 366 | rcode = nf_inq_var(cdfid,id,varnam,ivtype,ndims,dimids,natts) 367 | if (debug) write(*,*) 'ID, Number of dims for mask ',id,ndims 368 | do i = 1,ndims 369 | rcode = nf_inq_dimlen(cdfid,dimids(i),idims(i)) 370 | if (debug) write(*,*) 'Dimension ',i,idims(i) 371 | enddo 372 | 373 | if (nx /= idims(1)) print*, "nx (lon) and idims(1) don't match." 374 | if (ny /= idims(2)) print*, "ny (lat) and idims(2) don't match." 375 | if ( 1 /= idims(3)) print*, "idims(3) is not 1." 376 | 377 | istart(1) = 1 378 | istop(1) = nx 379 | istart(2) = 1 380 | istop(2) = ny 381 | istart(3) = 1 382 | istop(3) = 1 383 | rcode = nf_get_vara_int1(cdfid,id,istart,istop,mask_in) 384 | 385 | if (write_sst .or. write_landsea) then 386 | allocate( landsea(nx,ny) ) 387 | landsea = bad 388 | landsea = mask_in ! change to a regular interger 389 | 390 | if (crosses_180E) then 391 | my_temp2d(1:(nx-imid+1),:) = landsea(imid:nx,:) 392 | my_temp2d(imid:nx,:) = landsea(1:(nx-imid+1),:) 393 | landsea = my_temp2d 394 | endif 395 | 396 | ! convert from GHRSST's values: 397 | ! flag_meanings = "1=open-sea, 2=land, 5=open-lake, 9=open-sea with ice in the grid, \ 398 | ! 13=open-lake with ice in the grid" 399 | ! to WRF's 1 (land) or 0 (sea) values 400 | 401 | where (landsea == 1) landsea = 0 ! open-sea 402 | where (landsea == 2) landsea = 1 ! land 403 | where (landsea == 5) landsea = 0 ! open-lake, maybe should be 2 to use avg_tsfc? 404 | where (landsea == 9) landsea = 0 ! open-sea with ice in the grid 405 | where (landsea == 13) landsea = 0 ! open-lake with ice in the grid" 406 | 407 | if (debug) then 408 | write(*,*) "rcode = ",rcode 409 | write(*,*) "minval(mask_in) = ",minval(mask_in) 410 | write(*,*) "maxval(mask_in) = ",maxval(mask_in) 411 | write(*,*) "minval(landsea) = ",minval(landsea) 412 | write(*,*) "maxval(landsea) = ",maxval(landsea) 413 | end if 414 | 415 | end if 416 | 417 | if (write_ice) then 418 | allocate( landseaice(nx,ny) ) 419 | landseaice = bad 420 | landseaice = landsea ! we'll apply different codes below 421 | 422 | if (crosses_180E) then 423 | my_temp2d(1:(nx-imid+1),:) = landsea(imid:nx,:) 424 | my_temp2d(imid:nx,:) = landsea(1:(nx-imid+1),:) 425 | landsea = my_temp2d 426 | endif 427 | 428 | where (landseaice == 1) landseaice = 0 ! open-sea 429 | where (landseaice == 2) landseaice = 1 ! land 430 | where (landseaice == 5) landseaice = 0 ! open-lake, maybe should be 2 to use avg_tsfc? 431 | where (landseaice == 9) landseaice = 1 ! open-sea with ice in the grid 432 | where (landseaice == 13) landseaice = 1 ! open-lake with ice in the grid" 433 | end if 434 | 435 | end if ! if (write_landsea .or. append_landsea) then 436 | 437 | !************************************************************************************ 438 | ! Set some defaults, to prepare for writing 439 | !************************************************************************************ 440 | 441 | xlvl = 200100. 442 | dx = 0 ! km, not used in iProj = 0 (latlon) 443 | dy = 0 ! km 444 | map_source = 'JPL PODAAC GHRSST' 445 | xfcst = 0. 446 | 447 | ! set metadata 448 | 449 | if (geoflag == 0) then ! output full grid 450 | 451 | startloc = 'CENTER' ! SWCORNER means (1,1), CENTER means (nx/2,ny/2) 452 | startlat = 0. ! lat ranges from -90 to 90, or -80 to 80, center is 0. 453 | startlon = 0. ! lon ranges from -180 to 180, center is 0. 454 | ibeg = 1 ! write the full dataset 455 | jbeg = 1 456 | iend = nx 457 | jend = ny 458 | if (debug) then 459 | write(*,*) "Will output FULL grid:" 460 | write(*,*) " i-range: ",ibeg," to ",iend 461 | write(*,*) " j-range: ",jbeg," to ",jend 462 | endif 463 | 464 | else ! output a sub-set of the full grid 465 | 466 | startloc = 'SWCORNER' ! SWCORNER means (1,1), CENTER means (nx/2,ny/2) 467 | startlat = min_lat 468 | startlon = min_lon 469 | 470 | ! Not all GHRSST products are the same, so rather than calculate we'll search 471 | 472 | ibeg = 1 473 | do while (lons(ibeg) < min_lon) 474 | ibeg = ibeg + 1 475 | end do 476 | iend = ibeg 477 | do while (lons(iend) <= max_lon .and. iend < nx) 478 | iend = iend + 1 479 | end do 480 | 481 | jbeg = 1 482 | do while (lats(jbeg) < min_lat) 483 | jbeg = jbeg + 1 484 | end do 485 | jend = jbeg 486 | do while (lats(jend) <= max_lat .and. jend < ny) 487 | jend = jend + 1 488 | end do 489 | if (debug) then 490 | write(*,*) "Will output SUB-grid:" 491 | write(*,*) " i-range: ",ibeg," to ",iend 492 | write(*,*) " j-range: ",jbeg," to ",jend 493 | endif 494 | 495 | endif 496 | 497 | ! Figure out the grid dx,dy even though there's a global attribute (text) 498 | ! that says e.g. geospatial_lat_resolution = "0.01 degrees" 499 | 500 | i = nx/2 ; j = ny/2 501 | deltalat = nint((lats(j+1) - lats(j))*10000.)/10000. ! round to 0.0001 502 | deltalon = nint((lons(i+1) - lons(i))*10000.)/10000. 503 | if (debug) then 504 | write(*,*) "lats(1:10)", lats(1:10) 505 | write(*,*) "lons(1:10)", lons(1:10) 506 | endif 507 | 508 | if (write_landsea) then ! different from append_landsea, instead make a file 509 | 510 | !************************************************************************************ 511 | ! Create LANDSEA:YYYY-MM-DD_HH, following metgrid/src/read_met_module.f90. 512 | !************************************************************************************ 513 | 514 | ! set the filename, field, description, and units, and open the files 515 | 516 | filename = 'LANDSEA:'//hdate(1:13) 517 | field = 'LANDSEA' 518 | desc = 'Land Sea Mask' 519 | units = ' ' 520 | write(*,*) "Creating ",trim(filename) 521 | open(12,file=filename,form='unformatted',convert='big_endian') 522 | 523 | ! Write to the file, assuming iProj = 0 Cylindrical equidistant = latlon 524 | 525 | write(12) version 526 | write(12) hdate,xfcst,map_source,field,units,desc,xlvl, & 527 | iend-ibeg+1,jend-jbeg+1,iproj 528 | write(12) startloc,startlat,startlon,deltalat,deltalon,earth_radius 529 | 530 | if (debug) then 531 | write(*,*) "hdate ",hdate 532 | write(*,*) "xfcst ",xfcst 533 | write(*,*) "map_source ",map_source 534 | write(*,*) "field,units ",field,units 535 | write(*,*) "desc ",desc 536 | write(*,*) "xlvl ",xlvl 537 | write(*,*) "nx,ny ",nx,ny 538 | write(*,*) "iProj ",iProj 539 | write(*,*) "startloc ",startloc 540 | write(*,*) "startlat,startlon ",startlat,startlon 541 | write(*,*) "deltalat,deltalon ",deltalat,deltalon 542 | write(*,*) "earth_radius ",earth_radius 543 | endif 544 | 545 | ! 3) WRITE WIND ROTATION FLAG 546 | 547 | write(12) wind_grid_rel 548 | 549 | ! 4) WRITE 2-D ARRAY OF DATA 550 | 551 | if (debug) write(*,1) "Writing LANDSEA, i-range = ",ibeg,iend," j-range = ",jbeg,jend 552 | 553 | write(12) landsea(ibeg:iend,jbeg:jend) 554 | 555 | close(12) 556 | 557 | end if ! if (write_landsea) then 558 | 559 | if (write_sst) then 560 | 561 | !***************************************************************************** 562 | ! Get the variable attributes add_offset, scale_factor, and _FillValue for SST 563 | !***************************************************************************** 564 | 565 | allocate( sst_in(nx,ny), sst(nx,ny) ) 566 | 567 | rcode = nf_inq_varid(cdfid,'analysed_sst',id) 568 | if (debug) write(*,*) "rcode,id of analysed_sst =",rcode,id 569 | rcode = nf_get_att_int (cdfid,id,"_FillValue", bad_value) 570 | rcode = nf_get_att_real(cdfid,id,"add_offset", add_offset) 571 | rcode = nf_get_att_real(cdfid,id,"scale_factor",scale_factor) 572 | rcode = nf_get_att_real(cdfid,id,"valid_min", valid_min) 573 | rcode = nf_get_att_real(cdfid,id,"valid_max", valid_max) 574 | if (debug) then 575 | write(*,*) "For SST:" 576 | write(*,*) "_FillValue ", bad_value 577 | write(*,*) "bad_value ", bad, " (in sst)" 578 | write(*,*) "add_offset ", add_offset 579 | write(*,*) "scale_factor", scale_factor 580 | write(*,*) "valid_min ", valid_min 581 | write(*,*) "valid_max ", valid_max 582 | end if 583 | 584 | ! Get the 2D grid of values for SST 585 | 586 | rcode = nf_inq_var(cdfid,id,varnam,ivtype,ndims,dimids,natts) 587 | if (debug) write(*,*) 'ID, Number of dims for SST ',id,ndims 588 | do i = 1,ndims 589 | rcode = nf_inq_dimlen(cdfid,dimids(i),idims(i)) 590 | if (debug) write(*,*) 'Dimension ',i,idims(i) 591 | enddo 592 | 593 | if (nx /= idims(1)) print*, "nx (lon) and idims(1) don't match." 594 | if (ny /= idims(2)) print*, "ny (lat) and idims(2) don't match." 595 | if ( 1 /= idims(3)) print*, "idims(3) is not 1." 596 | 597 | istart(1) = 1 598 | istop(1) = nx 599 | istart(2) = 1 600 | istop(2) = ny 601 | istart(3) = 1 602 | istop(3) = 1 603 | rcode = nf_get_vara_int2(cdfid,id,istart,istop,sst_in) 604 | 605 | if (debug) then 606 | write(*,*) "rcode = ",rcode 607 | write(*,*) "minval(sst_in) = ",minval(sst_in) 608 | write(*,*) "maxval(sst_in) = ",maxval(sst_in) 609 | end if 610 | 611 | ! scale the sst_in to find output sst values 612 | 613 | sst = bad 614 | where (sst_in /= bad_value) sst = add_offset + scale_factor * sst_in 615 | 616 | if (crosses_180E) then 617 | my_temp2d(1:(nx-imid+1),:) = sst(imid:nx,:) 618 | my_temp2d(imid:nx,:) = sst(1:(nx-imid+1),:) 619 | sst = my_temp2d 620 | endif 621 | 622 | if (debug) then 623 | i = nx/5 ; j = ny/2 624 | write(*,*) "(i,j) = ",i,j 625 | write(*,*) "sst_in(i,j) = ",sst_in(i,j) 626 | write(*,*) "sst(i,j) = ",sst(i,j) 627 | write(*,*) "sst_in(nx,nx) = ",sst_in(nx,ny) 628 | write(*,*) "sst(nx,nx) = ",sst(nx,ny) 629 | write(*,*) "minval(sst) = ",minval(sst) 630 | write(*,*) "maxval(sst) = ",maxval(sst) 631 | end if 632 | 633 | !************************************************************************************ 634 | ! Create SST:YYYY-MM-DD_HH, following metgrid/src/read_met_module.f90. 635 | !************************************************************************************ 636 | 637 | filename = 'SST:'//hdate(1:13) 638 | field = 'SST' 639 | desc = 'Sea Surface Temperature' 640 | units = 'K' 641 | write(*,*) "Creating ",trim(filename) 642 | open(12,file=filename,form='unformatted',convert='big_endian') 643 | 644 | ! Write to the file, assuming iProj = 0 Cylindrical equidistant = latlon 645 | 646 | write(12) version 647 | write(12) hdate,xfcst,map_source,field,units,desc,xlvl, & 648 | iend-ibeg+1,jend-jbeg+1,iproj 649 | write(12) startloc,startlat,startlon,deltalat,deltalon,earth_radius 650 | 651 | if (debug) then 652 | write(*,*) "hdate ",hdate 653 | write(*,*) "xfcst ",xfcst 654 | write(*,*) "map_source ",map_source 655 | write(*,*) "field,units ",field,units 656 | write(*,*) "desc ",desc 657 | write(*,*) "xlvl ",xlvl 658 | write(*,*) "nx,ny ",nx,ny 659 | write(*,*) "iProj ",iProj 660 | write(*,*) "startloc ",startloc 661 | write(*,*) "startlat,startlon ",startlat,startlon 662 | write(*,*) "deltalat,deltalon ",deltalat,deltalon 663 | write(*,*) "earth_radius ",earth_radius 664 | endif 665 | 666 | ! 3) WRITE WIND ROTATION FLAG 667 | ! This line is in 668 | ! https://www2.mmm.ucar.edu/wrf/users/docs/user_guide_v4/v4.0/users_guide_chap3.html#_Writing_Meteorological_Data 669 | ! but not in https://www2.mmm.ucar.edu/wrf/src/netcdf-to-intermediate.f 670 | ! I asked on the WRF Forum, and Ming Chen said it's OK to leave it out. But the first ref is version 5, the 671 | ! netcdf-to-intermediate.f writes version 3. 672 | 673 | write(12) wind_grid_rel 674 | 675 | ! 4) WRITE 2-D ARRAY OF DATA 676 | 677 | if (debug) write(*,1) "Writing SST, i-range = ",ibeg,iend," j-range = ",jbeg,jend 678 | 1 format(1x,a,2i7,a,2i7) 679 | 680 | write(12) sst(ibeg:iend,jbeg:jend) 681 | 682 | if (append_landsea) then 683 | 684 | ! See https://forum.mmm.ucar.edu/phpBB3/viewtopic.php?f=31&t=9032, where I was told to 685 | ! write the LANDSEA mask in WPS Intermediate files. 686 | 687 | field = 'LANDSEA' 688 | desc = 'Land Sea Mask' 689 | units = ' ' 690 | write(12) version 691 | write(12) hdate,xfcst,map_source,field,units,desc,xlvl, & 692 | iend-ibeg+1,jend-jbeg+1,iproj 693 | write(12) startloc,startlat,startlon,deltalat,deltalon,earth_radius 694 | write(12) wind_grid_rel 695 | write(12) landsea(ibeg:iend,jbeg:jend) 696 | 697 | close(12) 698 | 699 | endif ! if (append_landsea) then 700 | 701 | deallocate( sst_in, sst ) ! done with these 702 | 703 | endif 704 | 705 | if (write_ice) then 706 | 707 | !************************************************************************************ 708 | !-----Get the variable attributes add_offset, scale_factor, and _FillValue for SEAICE 709 | !************************************************************************************ 710 | 711 | allocate( ice_in(nx,ny), ice(nx,ny) ) 712 | 713 | rcode = nf_inq_varid(cdfid,'sea_ice_fraction',id) 714 | if (debug) write(*,*) "rcode,id of ice_fraction =",rcode,id 715 | rcode = nf_get_att_int (cdfid,id,"_FillValue", bad_value) 716 | rcode = nf_get_att_real(cdfid,id,"add_offset", add_offset) 717 | rcode = nf_get_att_real(cdfid,id,"scale_factor",scale_factor) 718 | rcode = nf_get_att_real(cdfid,id,"valid_min", valid_min) 719 | rcode = nf_get_att_real(cdfid,id,"valid_max", valid_max) 720 | if (debug) then 721 | write(*,*) "For SEAICE:" 722 | write(*,*) "_FillValue ", bad_value 723 | write(*,*) "add_offset ", add_offset 724 | write(*,*) "scale_factor", scale_factor 725 | write(*,*) "valid_min ", valid_min 726 | write(*,*) "valid_max ", valid_max 727 | end if 728 | 729 | ! Get the 2D grid of values for SEAICE 730 | 731 | rcode = nf_inq_var(cdfid,id,varnam,ivtype,ndims,dimids,natts) 732 | if (debug) write(*,*) 'ID, Number of dims for SEAICE ',id,ndims 733 | do i = 1,ndims 734 | rcode = nf_inq_dimlen(cdfid,dimids(i),idims(i)) 735 | if (debug) write(*,*) 'Dimension ',i,idims(i) 736 | enddo 737 | 738 | if (nx /= idims(1)) print*, "nx (lon) and idims(1) don't match." 739 | if (ny /= idims(2)) print*, "ny (lat) and idims(2) don't match." 740 | if ( 1 /= idims(3)) print*, "idims(3) is not 1." 741 | 742 | istart(1) = 1 743 | istop(1) = nx 744 | istart(2) = 1 745 | istop(2) = ny 746 | istart(3) = 1 747 | istop(3) = 1 748 | rcode = nf_get_vara_int1(cdfid,id,istart,istop,ice_in) 749 | 750 | if (debug) then 751 | write(*,*) "rcode = ",rcode 752 | write(*,*) "minval(ice_in) = ",minval(ice_in) 753 | write(*,*) "maxval(ice_in) = ",maxval(ice_in) 754 | end if 755 | 756 | ! scale the ice_in to find output ice values 757 | 758 | ice = bad 759 | where (ice_in /= bad_value) ice = add_offset + scale_factor * ice_in 760 | 761 | if (crosses_180E) then 762 | my_temp2d(1:(nx-imid+1),:) = ice(imid:nx,:) 763 | my_temp2d(imid:nx,:) = ice(1:(nx-imid+1),:) 764 | ice = my_temp2d 765 | endif 766 | 767 | if (debug) then 768 | i = nx/5 ; j = ny/2 769 | write(*,*) "(i,j) = ",i,j 770 | write(*,*) "ice_in(i,j) = ",ice_in(i,j) 771 | write(*,*) "ice(i,j) = ",ice(i,j) 772 | write(*,*) "ice_in(nx,nx) = ",ice_in(nx,ny) 773 | write(*,*) "ice(nx,nx) = ",ice(nx,ny) 774 | write(*,*) "minval(ice) = ",minval(ice) 775 | write(*,*) "maxval(ice) = ",maxval(ice) 776 | end if 777 | 778 | !************************************************************************************ 779 | ! Create ICE:YYYY-MM-DD_HH, following metgrid/src/read_met_module.f90. 780 | !************************************************************************************ 781 | 782 | filename = 'SEAICE:'//hdate(1:13) 783 | field = 'SEAICE' 784 | desc = 'Sea Ice Flag' 785 | units = '0/1 Flag' 786 | write(*,*) "Creating ",trim(filename) 787 | open(12,file=filename,form='unformatted',convert='big_endian') 788 | 789 | ! Write to the file, assuming iProj = 0 Cylindrical equidistant = latlon 790 | 791 | write(12) version 792 | write(12) hdate,xfcst,map_source,field,units,desc,xlvl, & 793 | iend-ibeg+1,jend-jbeg+1,iproj 794 | write(12) startloc,startlat,startlon,deltalat,deltalon,earth_radius 795 | 796 | if (debug) then 797 | write(*,*) "hdate ",hdate 798 | write(*,*) "xfcst ",xfcst 799 | write(*,*) "map_source ",map_source 800 | write(*,*) "field,units ",field,units 801 | write(*,*) "desc ",desc 802 | write(*,*) "xlvl ",xlvl 803 | write(*,*) "nx,ny ",nx,ny 804 | write(*,*) "iProj ",iProj 805 | write(*,*) "startloc ",startloc 806 | write(*,*) "startlat,startlon ",startlat,startlon 807 | write(*,*) "deltalat,deltalon ",deltalat,deltalon 808 | write(*,*) "earth_radius ",earth_radius 809 | endif 810 | 811 | ! 3) WRITE WIND ROTATION FLAG 812 | 813 | write(12) wind_grid_rel 814 | 815 | ! 4) WRITE 2-D ARRAY OF DATA 816 | 817 | if (debug) write(*,1) "Writing SEAICE, i-range = ",ibeg,iend," j-range = ",jbeg,jend 818 | 819 | write(12) ice(ibeg:iend,jbeg:jend) 820 | 821 | if (append_landsea) then 822 | 823 | ! See https://forum.mmm.ucar.edu/phpBB3/viewtopic.php?f=31&t=9032, where I was told to 824 | ! write the LANDSEA mask in WPS Intermediate files. 825 | 826 | field = 'LANDSEA' 827 | desc = 'Land Sea Mask' 828 | units = ' ' 829 | write(12) version 830 | write(12) hdate,xfcst,map_source,field,units,desc,xlvl, & 831 | iend-ibeg+1,jend-jbeg+1,iproj 832 | write(12) startloc,startlat,startlon,deltalat,deltalon,earth_radius 833 | write(12) wind_grid_rel 834 | write(12) landseaice(ibeg:iend,jbeg:jend) ! landseaice has ice = 1, like land 835 | 836 | deallocate( landseaice ) 837 | 838 | end if ! if (append_landsea) then 839 | 840 | close(12) 841 | 842 | deallocate( ice_in, ice ) 843 | 844 | end if ! if (write_ice) then 845 | 846 | ! done with netcdf file, close it 847 | 848 | rcode = nf_close(cdfid) 849 | 850 | deallocate( lats, lons ) 851 | if (allocated( mask_in )) deallocate( mask_in ) 852 | if (allocated( landsea )) deallocate( landsea ) 853 | 854 | write(*,*) " *** Successful completion of program ghrsst-to-intermediate ***" 855 | 856 | end program ghrsst_to_intermediate 857 | ! 858 | !------------------------------------------------------------------------------ 859 | ! 860 | subroutine get_var_2d_real_cdf(cdfid,var,data,i1,i2,time,debug) 861 | ! 862 | !-----Read 2D real variable arrays 863 | ! 864 | implicit none 865 | include 'netcdf.inc' 866 | 867 | integer, intent(in) :: i1,i2,time 868 | logical, intent(in ) :: debug 869 | character (len=*), intent(in) :: var 870 | real, dimension(i1,i2), intent(out) :: data 871 | 872 | integer cdfid,rcode,id_data 873 | character (len=80) :: varnam 874 | integer :: ndims,natts,idims(10),istart(10),iend(10),dimids(10) 875 | integer :: i,ivtype 876 | ! 877 | !-----Entry point 878 | ! 879 | rcode = nf_inq_varid(cdfid,var,id_data) 880 | rcode = nf_inq_var(cdfid,id_data,varnam,ivtype,ndims,dimids,natts) 881 | if (debug) then 882 | write(*,*) 'Number of dims for ',var,' ',ndims 883 | endif 884 | do i = 1,ndims 885 | rcode = nf_inq_dimlen(cdfid,dimids(i),idims(i)) 886 | if (debug) write(*,*) 'Dimension ',i,idims(i) 887 | enddo 888 | ! 889 | !-----Check the dimensions 890 | ! 891 | if ( (i1 /= idims(1)) .or. & 892 | (i2 /= idims(2)) .or. & 893 | (time > idims(3)) ) then 894 | write(*,*) 'Error in 2d_var_real read, dimension problem' 895 | write(*,*) i1,idims(1) 896 | write(*,*) i2,idims(2) 897 | write(*,*) time,idims(4) 898 | write(*,*) 'Error stop' 899 | stop 900 | end if 901 | ! 902 | !-----Get the data 903 | ! 904 | istart(1) = 1 905 | iend(1) = i1 906 | istart(2) = 1 907 | iend(2) = i2 908 | istart(3) = time 909 | iend(3) = 1 910 | 911 | rcode = nf_get_vara_real( cdfid,id_data,istart,iend,data) 912 | 913 | end subroutine get_var_2d_real_cdf 914 | ! 915 | !------------------------------------------------------------------------------ 916 | ! 917 | subroutine usage 918 | 919 | write(*,*) "Usage: ghrsst-to-intermediate [Options] file.nc" 920 | write(*,*) "Options:" 921 | write(*,*) " -g geo_em.d01.nc Output sub-grid that covers this domain." 922 | write(*,*) " -b Slat,Nlat,Wlon,Elon Specify sub-grid manually (no spaces)." 923 | write(*,*) " -s | --sst Output SST:YYYY-MM-DD_HH files." 924 | write(*,*) " -i | --seaice Output SEAICE:YYYY-MM-DD_HH files." 925 | write(*,*) " -l | --landsea Output LANDSEA:YYYY-MM-DD_HH files." 926 | write(*,*) " -n | --nolandsea Don't append LANDSEA mask to SST ICE files." 927 | write(*,*) " -d | --debug Print debug messages to the screen." 928 | write(*,*) " -V | --version Print version number and exit." 929 | write(*,*) " -h | --help Show this help message." 930 | write(*,*) "Required:" 931 | write(*,*) " file.nc GHRSST file downloaded from the JPL PODAAC." 932 | write(*,*) 933 | write(*,*) "Converts GDS version 2 GHRSST datasets from JPL PODAAC (in netCDF format)" 934 | write(*,*) "to WPS intermediate format. See" 935 | write(*,*) "https://podaac.jpl.nasa.gov/datasetlist?ids=ProcessingLevel&values=*4*&search=GHRSST&view=list" 936 | write(*,*) 937 | write(*,*) "Example: " 938 | write(*,*) "ghrsst-to-intermediate -sst -l -g ../ERA5/geo_em.d01.nc \\" 939 | write(*,*) " 2014/20140101090000-JPL-L4_GHRSST-SSTfnd-MUR-GLOB-v02.0-fv04.1.nc" 940 | stop 941 | 942 | end subroutine usage 943 | --------------------------------------------------------------------------------