Commonly used commands

Page Contents

1. ifpInit
2. ifpnetCDF
3. iscMosaic
4. runProcedure
5. runIFPText
6. Launching CAVE with Switches

The ifpInit, ifpnetCDF, iscMosaic, runProcedure, and runIFPText scripts are located in the /awips2/GFESuite/bin directory.

ifpInit

The ifpInit script is used to manually run/rerun a Smart Init. The ifpInit script can take six switches: h, p, t, s, u, and a.

The h and p switches are predefined to match your AWIPS installation, such that they will point to EDEX on installation. Therefore, the h and p switches aren't needed for normal running of ifpInit. However, if you wish to connect to a different server, the h and p switches will be needed. Somewhere on the command line the algorithmFile will need to be specified. The algorithmFile is a required argument that specifies the name of the Smart Init you wish to run. Manually requested Smart Inits will queue ahead of other Smart Inits. Here are a few examples of running the ifpInit script:

• /awips2/GFESuite/bin/ifpInit -s BOU Local_GFS -a
  • This command runs the Local_GFS Smart Init as BOU for the latest model run of the GFS and creates all possible grids.
• /awips2/GFESuite/bin/ifpInit -s LIX -t 20220121_1400 Local_HRRR
  • This command runs the Local_HRRR Smart Init as LIX for the January 21, 2022 14Z run of the HRRR.
• /awips2/GFESuite/bin/ifpInit -s OAX -t 20220215_1200 Local_NAM12 -a
  • This command runs the Local_NAM12 Smart Init as OAX for the February 15, 2022 12Z run of the NAM12 and creates all possible grids.

ifpnetCDF

The ifpnetCDF script is the GFE grid extraction program. This script extracts grids from ifpServer databases and puts them into netCDF format. The ifpnetCDF script is used to create compressed netCDF files. This script is also used to archive the forecast database for WES or a cloud case. The ifpnetCDF script can use 17 different switches: o, h, r, u, d, p, s, e, m, g, c, f, t, k, C, v, and S.

The o switch while technically optional needs to be provided so that you can access the netCDF file that the script creates. The h and r switches are predefined to match your AWIPS installation, such that they will point to EDEX on installation. Therefore, the h and r switches aren't needed for normal running of ifpnetCDF. However, if you wish to connect to a different server, the h and r switches will be needed. When the f switch is provided, the c switch must also be provided. If the k switch is provided, then the t switch is required.

iscMosaic

The iscMosaic script puts netCDF files back together into a database. This script was originally created and is used for intersite coordination. The iscMosaic script can be used to ingest netCDF files into the server. It is useful for archive case creation/restoration on a cloud instance or WES. It is also used when backing up a site and extracting the failed site's grids and configuration that were downloaded from the Central Server. The iscMosaic script can use 23 different switches: h, r, u, d, p, f, b, s, e, x, z, n, a, w, k, i, D, o, S, T, v, A, and y.

The h and r switches are predefined to match your AWIPS installation, such that they will point to EDEX on installation. Therefore, the h and r switches aren't needed for normal running of iscMosaic. However, if you wish to connect to a different server, the h and r switches will be needed. The n and a switches cannot be provided together since they are mutually exclusive. If more than one f switch is provided, then the z switch cannot be provided and the x switch should not be provided. For the purposes of ISC, the s, e, x, z, n, and a switches must not be provided and the b switch should be provided. The iscMosaic script ignores the database time constraints, so if the data to be stored does not fall within a valid time constraint, the grid will not be stored. This isn't an issue for ISC, since its grids are stored into the ISC database, which has time constraints of 1 hour.

runProcedure

The runProcedure script is used to run/execute a procedure from the command line. This script doesn't allow for user interaction with the procedure and so procedure GUIs will not open when running a procedure using this script. The runProcedure script can use 10 different switches: n, u, c, a, s, e, t, m, z, and V.

If the s switch is specified, then the e switch is required. The t switch or the s and e switches usually must be specified, unless a time is provided in the variable list argument (V switch), since procedures usually run over a time range. The V switch is only optional (not required) for procedures that don't take user input. The u switch is only optional (not required) when using a SITE-level configuration file or gfeConfig.py as the configuration file. Here are a few examples of running the runProcedure script:

• /awips2/GFESuite/bin/runProcedure -n PlotSPCWatches -c BOU_gfeConfig -a BOU -t Today
  • This command runs the PlotSPCWatches.py procedure on the BOU edit area for the Today time range using the BOU_gfeConfig.py configuration file.
• /awips2/GFESuite/bin/runProcedure -n Aviation_CloudBaseFromRH -c OAX_gfeConfig -s 20220120_1200 -e 20220121_0300 -V '{"Use AGL cloud heights:":"Yes","Populate:":"CloudBasePrimary","NAM12":"0","Previous NAM12":"0","GFS":"1","Previous GFS":"0","RAP13":"0","Previous RAP13":"0","Alter RH thresholds for clouds by (%):":20}'
  • This command runs the Aviation_CloudBaseFromRH.py procedure starting from 02Z January 20, 2022 to 03Z January 21, 2022 using AGL cloud heights, populating the CloudBasePrimary weather element, weighting the current and previous runs of the NAM12 and RAP13 at 0, weighting the current run of the GFS at 1, weighting the previous run of the GFS at zero, and increasing the RH threshold for clouds by 20% using the OAX_gfeConfig.py configuration file.
• /awips2/GFESuite/bin/runProcedure -n Align_Grids -c LIX_gfeConfig -a LIX -V '{"Select Time Range:": "All", "Source Grid:": "PoP", "Aligned Grids:": ["Wx", "PoP", "Sky", "QPF","SnowAmt","IceAccum","Wind","WindGust"]}'
  • This command runs the Align_Grids.py procedure on the LIX edit area using the All Select Time Range option with the PoP Source Grid on the Wx, PoP, Sky, QPF, SnowAmt, IceAccum, Wind, and WindGust grids using the LIX_gfeConfig.py configuration file.
• /awips2/GFESuite/bin/runProcedure -n CheckTandTd -c siteConfig -s 20220208_0000 -e 20220210_0200 -V '{ "Check or Force:":"Check Only"}' -m _NAM12_20220208_0000
  • This command runs the CheckTandTd.py procedure starting from 00Z February 8, 2022 to 02Z February 10, 2022 on grids from the 00Z February 8, 2022 run of the NAM12 using the Check Only Check or Force option and the siteConfig.py configuration file.

runIFPText

The runIFPText script is used to run/execute a text formatter from the command line. The script is also used by default when a text formatter is run using the formatter launcher. The runIFPText script can use 20 different switches: d, t, c, o, S, u, l, A, V, O, z, T, E, v, a, r, w, s, e, and i.

The E and T switches cannot not be provided together since they are mutually exclusive. If the s switch is specified, then the e switch is required. The u switch is only optional (not required) when using a SITE- or BASE-Level configuration file or edit area. Here are a few examples of running the runIFPText script:

• /awips2/GFESuite/bin/runIFPText -t ZFP_BOU -d BOU_GRID__Official_00000000_0000 -A /awips2/GFESuite/products/TEXT/ZFP.txt -V '{("Product Issuance", "productIssuance"): "Morning", ("Issued By", "issuedBy"): ""}' -v O -a active
  • This command runs the Morning version of the ZFP_BOU text formatter using BOU's Official database in the O vtecMode using the active active table and appending the output of the formatter to the ZFP.txt file located in the /awips2/GFESuite/products/TEXT/ directory.
• /awips2/GFESuite/bin/runIFPText -t AFD_LIX -d LIX_GRID__Official_00000000_0000 -V '{("Product Issuance", "productIssuance"): "Morning", ("""Short Term\nForecaster""", "shortTermFcstrNumber"): "01", ("Issued By", "issuedBy"): "", ("""Optional\nTopics""", "optionalTopics"): [".UPDATE..."], ("""Aviation\nForecaster""", "aviationFcstrNumber"): "01", ("""Include\nPrevious AFD?""", "includePreviousAFD"): "NO", ("""Long Term\nForecaster""", "longTermFcstrNumber"): "02"}' -v E
  • This command runs the Morning version of the AFD_LIX text formatter using LIX's Official database in the E vtecMode as the Short Term Forecaster number 01, as an Update to a previous version of the formatter, as the Aviation Forecaster number 01, without including the previous AFD, and as the Long Term Forecaster number 02.
• /awips2/GFESuite/bin/runIFPText -t AFM_OAX -d OAX_GRID__Official_00000000_0000 -V '{("Product Issuance", "productIssuance"): "Morning", ("Issued By", "issuedBy"): ""}' -o /awips2/GFESuite/products/TEXT/AFM.txt -c OAX_gfeConfig -v X
  • This command runs the Morning version of the AFM_OAX text formatter using OAX's Official database in the X vtecMode writing the output of the formatter to the AFM.txt file located in the /awips2/GFESuite/products/TEXT/ directory using the OAX_gfeConfig.py configuration file.
• /awips2/GFESuite/bin/runIFPText -t Hazard_FFA -d FSD_GRID__Official_00000000_0000 -V '{("Issued By", "issuedBy"): "", ("Flood Reason (HVTEC)", "floodReason"): "SM (Snow Melt)"}' -v T
  • This command runs the Hazard_FFA text formatter using FSD's Official database in the T vtecMode where the Flood Reason (HVTEC) is SM (Snow Melt).
• /awips2/GFESuite/bin/runIFPText -t AQA_ER -d RNK_GRID__Official_00000000_0000 -V '{("Alert Level", "alertCode"): "Orange", ("Issued By", "issuedBy"): "", ("Alert Type", "alertType"): "Ozone Action Day"}' -E
  • This command runs the AQA_ER text formatter using RNK's Official database in EXPERIMENTAL mode using the Orange Alert level and Ozone Action Day Alert Type.
• /awips2/GFESuite/bin/runIFPText -t CivilEmerg_CDW_LA_Local -d LIX_GRID__Official_00000000_0000 -V '{("Issued By", "issuedBy"): "", ("Source", "source"): "Louisiana EMERGENCY MANAGEMENT AGENCY New Orleans Louisiana", ("EAS Level", "eas"): "URGENT - IMMEDIATE BROADCAST REQUESTED"}' -a PRACTICE
  • This command runs the CivilEmerg_CDW_LA_Local text formatter using LIX's Official database using the PRACTICE active table using Louisiana EMERGENCY MANAGEMENT AGENCY New Orleans Louisiana as the Source and URGENT - IMMEDIATE BROADCAST REQUESTED as the EAS Level.
• /awips2/GFESuite/bin/runIFPText -t ESF_Local -d DMX_GRID__Fcst_00000000_0000 -z 20211231_1200 -T
  • This command runs the ESF_Local text formatter using DMX's Forecast database in displaced real time mode at 12Z on December 31, 2021 in TEST mode.

Launching CAVE with Switches

CAVE can be launched using various switches which will be described in the jobsheet below.