NOAA-OWP · cmaynard-ngwpc · Jul 2, 2024 · Jul 2, 2024 · Jul 2, 2024 · Jul 2, 2024
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,9 +2,12 @@ cmake_minimum_required(VERSION 3.12)
 enable_language( Fortran )
 add_subdirectory(../iso_c_fortran_bmi ${CMAKE_BINARY_DIR}/iso_c_bmi)
 
+set( CMAKE_VERBOSE_MAKEFILE on )
+
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/../../cmake/")
 # Uncomment this and rebuild artifacts to enable debugging
 #set(CMAKE_BUILD_TYPE Debug)
+
 add_compile_options(
   "-Wall"
   "$<$<CONFIG:DEBUG>:-g;-fbacktrace;-fbounds-check>"
@@ -63,7 +66,8 @@ set(MODEL_SOURCE_DIR src/)
 set(BMI_SOURCE_DIR src/bmi/)
 
 file(GLOB BMI_SOURCE ${BMI_SOURCE_DIR}*.f90)
-file( GLOB MODEL_SOURCES ${MODEL_SOURCE_DIR}/snow19/*.f ${MODEL_SOURCE_DIR}/driver/*.f90 ${MODEL_SOURCE_DIR}/share/*.f90)
+#file( GLOB MODEL_SOURCES ${MODEL_SOURCE_DIR}/snow19/*.f ${MODEL_SOURCE_DIR}/driver/*.f90 ${MODEL_SOURCE_DIR}/share/*.f90)
+file( GLOB MODEL_SOURCES ${MODEL_SOURCE_DIR}/snow19/*.f  ${MODEL_SOURCE_DIR}/share/*.f90 ${MODEL_SOURCE_DIR}/driver/*.f90 ${CMAKE_CURRENT_LIST_DIR}/../datetime-fortran-1.7.0/src/*.f90)
 
 if(WIN32)
     add_library(snow17bmi ${BMI_SOURCE} )
@@ -72,16 +76,19 @@ else()
 endif()
 
 #target_include_directories(snow17bmi PUBLIC ${netCDF_INCLUDE_DIR} ${netCDF_MOD_PATH})    # netcdf not needed for this code
-target_include_directories( snow17bmi PUBLIC )    
+#target_include_directories( snow17bmi PUBLIC ${FDATETIME_INCLUDE_DIRS} )    
 
 #We know we are building this for NGEN support, so define the preprocessor directive in the compile options
 #Not sure why the global 
 target_compile_options(snow17bmi PUBLIC -cpp -ffree-line-length-none)
+#target_compile_options(snow17bmi PUBLIC -O3 -fdefault-real-8 -fno-align-commons -ffree-line-length-none -cpp -fcheck=all)
 
 ##### NETCDF #####
 #target_link_libraries( snow17bmi iso_c_bmi ${netCDF_C_LIB} ${netCDF_FORTRAN_LIB})
 ##### END NETCDF #####
+#target_link_libraries( snow17bmi PUBLIC iso_c_bmi fortran_stdlib::fortran_stdlib ${FDATETIME_LIBRARIES} )
 target_link_libraries( snow17bmi PUBLIC iso_c_bmi )
+
 set_target_properties(snow17bmi PROPERTIES VERSION ${PROJECT_VERSION})
 
 include(GNUInstallDirs)

diff --git a/INSTALL.md b/INSTALL.md
@@ -22,4 +22,30 @@ cd ../output/             # to view output data
 ```
 Note that the ex1/ example is part of the repo.  The unpacked directory and test contents will not be included in a push back to the online repo.  To the program for other purposes, create new input files and output directories outside of the `snow17/` repository directory, and link to the executable in `snow17/bin/`. 
 
+## Logger
+
+The Errror Warning and Trapping Systems (EWTS) has been added to this module using a logging schema. All write statements have been converted to `write_log` statements, which saves the ouptut to a log file based on the log level.
+
+When running within the ngen framework, the log file and log level are handled programatically. When running standalone, logging is defaulted to DISABLED. 
+
+**Running Standalone**
+
+In order to generate log messages when running standalone, the `NGEN_EWTS_LOGGING` environment variable must be set to `ENABLED`. This is the only required environment variable . Other optional logger environment variables exist for specifying the log file full pathname and setting the log level. If the user only enables logging, the log level will be set to INFO and the filename will be created based on the user and module names. All logger setup details are written to the console when the module is run. 
+```
+# Case Sensitive
+export NGEN_EWTS_LOGGING=ENABLED
+export NGEN_LOG_FILE_PATH=<full pathname for log file>
+export SNOW17_LOGLEVEL=<DEBUG, INFO, WARNING, SEVERE, FATAL>
+```
+**Log Levels**
+| Level   | Description                                         | Typical Use                                   |
+|---------|-----------------------------------------------------|-----------------------------------------------|
+| DEBUG   | Detailed diagnostic info for development/troubleshooting. | Variable values, function entry/exit. |
+| FATAL   | Critical failure that aborts or makes app unrecoverable. | Crashes, memory errors, invalid state.        |
+| INFO    | General events confirming expected operations.       | Startup/shutdown, configs, task completions.  |
+| SEVERE  | Significant problem; app may continue in degraded state. | Failed services, corrupted configs, data loss.|
+| WARNING | Potential issue that doesn’t stop execution.         | Deprecated APIs, missing files, repeatable errors. |
+
+Default log level is INFO. The log level is hierarchical. Setting it to INFO, will log INFO, WARNING, SEVERE and FATAL
+messages.
 
diff --git a/LICENSE b/LICENSE
@@ -1,3 +1,25 @@
+Copyright 2025 Raytheon Company
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation 
+and/or other materials provided with the distribution.
+
+Licensed under: https://opensource.org/license/bsd-2-clause
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+All rights reserved. Based on Government sponsored work under contract GS-35F-204GA.
+
+-----------------
+
+“Software code created by U.S. Government employees is not subject to copyright
+in the United States (17 U.S.C. §105). The United States/Department of Commerce
+reserve all rights to seek and obtain copyright protection in countries other
+than the United States for Software authored in its entirety by the Department
+of Commerce. To this end, the Department of Commerce hereby grants to Recipient
+a royalty-free, nonexclusive license to use, copy, and create derivative works
+of the Software outside of the United States.”
 
                                  Apache License
                            Version 2.0, January 2004

diff --git a/build/Makefile b/build/Makefile
@@ -1,146 +1,163 @@
 #========================================================================
 # Makefile to compile the Snow-17 and driver code for multi-zone model
 #========================================================================
-
+ 
 #========================================================================
 # PART 1: Define directory paths and compiler
-
+ 
 # Define main/top directory (parent of /build/)
 # Note:  the relative path of "../" drops into snow17 parent directory
 F_MASTER_DIR = ../
-
+DATETIME_FORTRAN_INSTALLATION_DIR=../../../extern
+
 # Location of the compiled modules
 # MOD_PATH = $(F_MASTER_DIR)/build/ -- not used
-
+ 
 # Define directories
 driver_dir = $(F_MASTER_DIR)/src/driver/
 snow19_dir = $(F_MASTER_DIR)/src/snow19/
 share_dir  = $(F_MASTER_DIR)/src/share/
 bmi_dir    = $(F_MASTER_DIR)/src/bmi/
 exe_dir    = $(F_MASTER_DIR)/bin/
-
+fdatetime_dir = $(DATETIME_FORTRAN_INSTALLATION_DIR)/datetime-fortran-1.7.0/src/
+
 # Define the executable and path
 EXE = $(exe_dir)/snow17.exe
-
+ 
 # Define your Fortran compiler
 #FC  = pgf90
 #FC  = ifort
 FC   = gfortran
-
+ 
 #========================================================================
 # PART 2: Define the libraries and flags (can be an include file)
-
+ 
 # --- Define the libraries and path to include files
 ifeq "$(FC)" "pgf90"
  LOCL_PATH = /usr/local
- LIB = -L$(LOCL_PATH)/lib 
+ LIB = -L$(LOCL_PATH)/lib
  INC = -I ./
 endif
-
+ 
 ifeq "$(FC)" "gfortran"
  LOCL_PATH = /usr/local
- LIB = -L$(LOCL_PATH)/lib 
+ LIB = -L$(LOCL_PATH)/lib
  INC = -I ../
 endif
-
+ 
 # --- Define flags
 ifeq "$(FC)" "gfortran"
   FLAGS_DEBUG = -static -Wall -g -ffree-line-length-none -cpp -fcheck=all
-  FLAGS = -O3 -fdefault-real-8 -fno-align-commons -ffree-line-length-none -cpp -fcheck=all
-  FLAGS2 = -O3 -fdefault-real-8 -fno-align-commons -ffree-line-length-none -cpp -fcheck=all
+  #FLAGS = -O3 -fdefault-real-8 -fno-align-commons -ffree-line-length-none -cpp -fcheck=all
+  FLAGS = -O3 -fno-align-commons -ffree-line-length-none -cpp -fcheck=all
+  #FLAGS2 = -O3 -fdefault-real-8 -fno-align-commons -ffree-line-length-none -cpp -fcheck=all
+  FLAGS2 = -O3 -fno-align-commons -ffree-line-length-none -cpp -fcheck=all
 endif
-
+ 
 ifeq "$(FC)" "ifort"
   FLAGS_PROF = -static -debug -warn all -check all -FR -O0 -auto -WB -traceback -g -fltconsistency -fpe0
   FLAGS = -O3 -warn all -check all
-  FLAGS2 = -O3 
-  FLAGS77 = -O3 -f77rtl 
+  FLAGS2 = -O3
+  FLAGS77 = -O3 -f77rtl
 endif
-
+ 
 ifeq "$(FC)" "pgf90"
   FLAGS_PROF = -Bstatic -Mbackslash -g -Mchkptr -Mchkstk -Mpgicoff -Minform=inform -Ktrap=divz,inv -Mprof=lines,time
   # FLAGS = -Mfreeform -O3 -Mbackslash -g -Mchkptr -Mchkstk -Mpgicoff -Minform=inform -Ktrap=divz,inv
   FLAGS = -O3 -r8 -Kieee
   FLAGS2 = -O3 -r8
 endif
-
-
+ 
+ 
 #========================================================================
 # PART 3: Assemble all of the various subroutines
-
+ 
 # --- snow-19 code (fortran 90, different options)
 snow19 = \
-		zero19.f \
-		rout19.f \
-		aesc19.f \
-		melt19.f \
-		SNEW.f \
-		SNOWT.f \
-		SNOWPACK.f \
-		adjc19.f \
-		aeco19.f \
-		updt19.f \
-		SNDEPTH.f \
-		PACK19.f \
-		exsnow19.f
+        zero19.f \
+        rout19.f \
+        aesc19.f \
+        melt19.f \
+        SNEW.f \
+        SNOWT.f \
+        SNOWPACK.f \
+        adjc19.f \
+        aeco19.f \
+        updt19.f \
+        SNDEPTH.f \
+        PACK19.f \
+        exsnow19.f
 model_snow19 = $(patsubst %, $(snow19_dir)/%, $(snow19))
-
-
+ 
+ 
 # -- share utilities and code used by the driver in running the model
 run_util = \
-	nrtype.f90 \
-	constants.f90 \
-	namelistModule.f90 \
+	snowLogger.f90 \
+    nrtype.f90 \
+    constants.f90 \
+    namelistModule.f90 \
         parametersType.f90 \
         forcingType.f90 \
         dateTimeUtilsModule.f90 \
         runInfoType.f90 \
         modelVarType.f90 \
         ioModule.f90 \
-        runSnow17.f90 
+        byte_utilities.f90 \
+        messagepack_value.f90 \
+        messagepack_user.f90 \
+        messagepack.f90 \
+        runSnow17.f90
 
 model_run = $(patsubst %, $(share_dir)/%, $(run_util))
-
+ 
 # --- BMI functions used by the driver to run the model
 bmi_functions = bmi.f90 bmi_snow17.f90
 snow17_bmi    = $(patsubst %, $(bmi_dir)/%, $(bmi_functions))
+
+fdatetime_code = datetime_module.f90
+fdatetime = $(patsubst %, $(fdatetime_dir)/%, $(fdatetime_code))
 
 # --- snow17 driver
 driver_snow17 = driver_bmi.f90
 snow17_drv    = $(patsubst %, $(driver_dir)/%, $(driver_snow17))
-
-
+ 
+ 
 # --- prepare to stitch it all together      # check just using the original names ... this does nothing?
 run_code = $(model_run)
 model    = $(model_snow19)
 bmi      = $(snow17_bmi)
-
-
+ 
+ 
 #========================================================================
-# PART 4: Compile it 
-
-all: model link clean 
+# PART 4: Compile it
+ 
+all: model link clean
 debug: model_debug link
-devel: model link 
-
+devel: model link
+ 
 check:
 	echo test
 	echo $(FC)
-
+ 
 # compile model code
 model:
-	$(FC) $(FLAGS2) -c $(model) $(INC)
+	#$(FC) $(FLAGS2) -c $(model) $(INC) $(STDLIB_CFLAGS) $(DATETIME_F_CFLAGS)
+	$(FC) $(FLAGS2) -c $(model) $(fdatetime) $(INC)
+	#$(FC) $(FLAGS) -c $(run_code) $(bmi) $(snow17_drv) $(INC) $(STDLIB_CFLAGS) $(DATETIME_F_CFLAGS)
 	$(FC) $(FLAGS) -c $(run_code) $(bmi) $(snow17_drv) $(INC)
-
+ 
 model_debug:
-	$(FC) $(FLAGS2) -g -fcheck=all -c $(model) $(INC)
-	$(FC) $(FLAGS) -g -fcheck=all -c $(run_code) $(bmi) $(snow17_drv) $(INC)
-
+	#$(FC) $(FLAGS2) -g -fcheck=all -c $(model) $(INC) $(STDLIB_CFLAGS) $(DATETIME_F_CFLAGS)
+	$(FC) $(FLAGS2) -g -fcheck=all -c $(model) $(fdatetime) $(INC)
+	#$(FC) $(FLAGS) -g -fcheck=all -c $(run_code) $(bmi) $(snow17_drv) $(INC) $(STDLIB_CFLAGS) $(DATETIME_F_CFLAGS)
+	(FC) $(FLAGS) -g -fcheck=all -c $(run_code) $(bmi) $(snow17_drv) $(INC)
+
 # link routines
 link:
-#	$(FC) -fPIC -Bstatic_pgi -rpath,/usr/local/netcdf4-pgi/lib *.o -I./ $(LIBNETCDF) -o $(EXE)
-	$(FC) -fPIC -I./ $(LIB) -o $(EXE) *.o 
-
+#   $(FC) -fPIC -Bstatic_pgi -rpath,/usr/local/netcdf4-pgi/lib *.o -I./ $(LIBNETCDF) -o $(EXE)
+	#$(FC) -fPIC -I./ $(LIB) -o $(EXE) *.o  $(STDLIB_LIBS) $(DATETIME_F_LIBS)
+	$(FC) -fPIC -I./ $(LIB) -o $(EXE) *.o
+
 # Remove object files
 clean:
 	rm -f *.o