cleanRunDirs

#!/usr/bin/perl -w

#------------------------------------------------------------------------------
#                  GEOS-Chem Global Chemical Transport Model                  !
#------------------------------------------------------------------------------
#BOP
#
# !MODULE: cleanRunDirs
#
# !DESCRIPTION: This Perl script removes all output files from the
#  GEOS-Chem Unit Test run directories.
#\\
#\\
# !USES:
#
require 5.003;                 # Need this version of Perl or newer
use strict;                    # Force IMPLICIT NONE-style declarations
use FindBin qw/$RealBin/;      # Look for perl modules
use lib        $RealBin;       #  in the current folder
use UtUtils qw/&cleanDir
               &parse/;        # Get routines from module UtUtils.pm
#
# !PUBLIC MEMBER FUNCTIONS:
#
# &getDirs($)
# &cleanDir($)
# &main(@)         
#
# !CALLING SEQUENCE:
#  cleanRunDirs [ OPTIONS-FILENAME ]
#
# !REVISION HISTORY:
#  01 Oct 2015 - M. Sulprizio- Initial version based on cleanFiles
#EOP
#------------------------------------------------------------------------------
#                  GEOS-Chem Global Chemical Transport Model                  !
#------------------------------------------------------------------------------
#BOP
#
# !IROUTINE: getDefaults
#
# !DESCRIPTION: Reads the input file and returns the name of the directory 
#  where run directories are stored.
#\\
#\\
# !INTERFACE:
#
sub getDirs($) {
#
# !INPUT PARAMETERS:
#
  my ( $fileName ) = @_;   # File with unit test input options
#
# !RETURN VALUE:
#
  my $runDir       = "";    # Run directory
#
# !CALLING SEQUENCE:
#  &getDirs( $fileName );   # Saves values to global variables
#
# !REVISION HISTORY:
#  01 Oct 2015 - M. Sulprizio- Initial version based on getDirs in cleanFiles
#EOP
#------------------------------------------------------------------------------
#BOC
#
# !LOCAL VARIABLES:
#
  # Scalars
  my $home   = "";
  my $utRoot = "";
  my $user   = "";

  # Arrays
  my @txt  = ();
 
  #-------------------------------------------------------------------------
  # If no filename is passed, return relative data paths
  #-------------------------------------------------------------------------
  if ( $fileName eq "RELATIVE" ) {
    $runDir = "../runs"; 
    return( $runDir  );
  }

  #-------------------------------------------------------------------------
  # Otherwise, read the data paths from the specified input filename
  #-------------------------------------------------------------------------

  # Read data from input file
  open( I, "<$fileName" ) or die "Cannot open $fileName!\n";
  chomp( @txt = <I> );
  close( I );

  # Get home directory
  $home = $ENV{"HOME"};

  # Get username
  $user = $ENV{"USER"};

  # Parse each line until we find the log directory
  for ( my $i = 0; $i < scalar( @txt ); $i++ ) {
    if ( $txt[$i] =~ "RUN_ROOT" ) { $runDir = &parse( $txt[$i] ); }
    if ( $txt[$i] =~ "UNIT_TEST_ROOT" ) { $utRoot = &parse( $txt[$i] ); }
  }

  # Replace directory tokens
  $utRoot =~ s/{HOME}/$home/g;
  $runDir =~ s/{HOME}/$home/g;
  $runDir =~ s/{USER}/$user/g;
  $runDir =~ s/{UTROOT}/$utRoot/g;

  # Return to main program
  return( $runDir  );
}
#EOC
#------------------------------------------------------------------------------
#                  GEOS-Chem Global Chemical Transport Model                  !
#------------------------------------------------------------------------------
#BOP
#
# !IROUTINE: main
#
# !DESCRIPTION: Removes files from the GEOS-Chem Unit Test run directories.
#\\
#\\
# !INTERFACE:
#
sub main() {
#
# !CALLING SEQUENCE:
#  cleanRunDirs [ OPTIONS-FILENAME ]
#
# !REVISION HISTORY:
#  01 Oct 2015 - M. Sulprizio- Initial version based on main in cleanFiles
#EOP
#------------------------------------------------------------------------------
#BOC
#
# !LOCAL VARIABLES:
#
  # Scalars
  my $cmd     = "";
  my $dir     = "";
  my $optFile = "";
  my $runDir  = "";
  my $runRoot = "";
  my $result  = "";
  
  # Arrays
  my @dirs    = ();

  # If the user passes a filename from the command line, use it
  # Otherwise, default to "UnitTest.input"
  if ( scalar( @ARGV ) == 1 ) { $optFile = $ARGV[0];   }
  else                        { $optFile = "RELATIVE"; }

  # Get the local directories
  ( $runRoot ) = &getDirs( $optFile );

  # Get all of the subdirectories of $runDir
  opendir( D, "$runRoot" ) or die "$runRoot is an invalid directory!\n";
  chomp( @dirs = readdir( D ) );
  closedir( D );

  # Loop over all contents in the root run directory ($RUN_ROOT)
  foreach $dir ( @dirs ) {

    # Construct full path name for subdirectory $dir
    $runDir = "$runRoot/$dir";

    # Make sure each directory is a directory and not a file
    if ( -d $runDir ) { 
      
      # Also Skip over . and ..
      if ( !( $dir =~ m/^\./ ) ) {

	# Skip over chem_inputs/
	if ( !( $dir =~ m/chem_inputs/ ) ) { 

	  # Remove files in each run directory ...
	  print "==> Removing files in $runDir\n";
	  $cmd  = "cd $runDir; ";
          $cmd .= "rm -f input.geos HEMCO_Config.rc HEMCO.log ";
          $cmd .= "HEMCO_diagnostics.* HISTORY.rc Ox.mass.* Makefile ";
          $cmd .= "lastbuild* *.sp *.mp *info.dat input.geos.g* ";
          $cmd .= "input.geos.m* GEOSChem.Restart* core.* *.nc4 ";
	  $cmd .= "HEMCO_Config.rc.g* HEMCO_Config.rc.m* trac_avg.* ";
	  $cmd .= "Rn.mass.* GEOS-Chem_Species_Database.json;";
	  $cmd .= "rm -rf OutputDir;";
	  $cmd .= "cd ..";
          #print "$cmd\n";
	  qx/$cmd/;
        }
      }
    }
  }	

  # Return w/ status
  return( $? );
}
#EOC

#------------------------------------------------------------------------------

# Call main driver routine
main();

# Exit and pass status code to Unix shell
exit( $? );