Merge branch 'main' of github.com:NOAA-GFDL/GFDL-VortexTracker into main

Author: TimMarchok-NOAA

.gitignore

@@ -0,0 +1,55 @@
+# Compiled Object files
+**/.DS_Store
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+**/cmake-build-debug
+**/CMakeCache.txt
+**/cmake_install.cmake
+**/install_manifest.txt
+**/CMakeFiles/
+**/CTestTestfile.cmake
+**/Makefile
+**/*.cbp
+**/CMakeScripts
+**/compile_commands.json
+
+include/divisible/*
+
+
+## Local 
+
+.idea/*.xml
+
+build/**/*
+
+include/*
+lib/*
+bin/*
+test/test_runner

CMakeLists.txt

@@ -0,0 +1,37 @@
+#=======================================================================
+#$$$ CMAKEFILE DOCUMENTATION BLOCK
+# Biju Thomas
+# Email: biju.thomas@noaa.gov
+#=======================================================================
+
+cmake_minimum_required(VERSION 3.15)
+project( 
+  HAFS_TOOLS
+  LANGUAGES C Fortran)
+
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules/")
+
+message(CMAKE_MODULE_PATH " ${CMAKE_MODULE_PATH}")
+if(NOT CMAKE_Fortran_COMPILER_ID MATCHES "^(Intel|GNU)$")
+  message(WARNING "Compiler not officially supported: ${CMAKE_Fortran_COMPILER_ID}")
+endif()
+
+if(NOT CMAKE_C_COMPILER_ID MATCHES "^(Intel|GNU)$")
+  message(WARNING "Compiler not officially supported: ${CMAKE_C_COMPILER_ID}")
+endif()
+
+
+find_package(HDF5 REQUIRED)
+find_package(NetCDF REQUIRED C Fortran)
+find_package(PNG REQUIRED)
+find_package(Jasper REQUIRED)
+find_package(ZLIB REQUIRED)
+find_package(g2 REQUIRED)
+find_package(bacio REQUIRED)
+find_package(w3nco REQUIRED)
+find_package(w3emc REQUIRED)
+
+add_subdirectory(src/support/supvit/)
+add_subdirectory(src/support/tave/)
+add_subdirectory(src/support/vint/)
+add_subdirectory(src/tracker/)

README

@@ -0,0 +1,42 @@
+# 🌊 GFDL Vortex Tracker 🌀
+
+  This program tracks the average of the max or min of several parameters in the vicinity of an input
+first guess (lat,lon) position of a vortex in order to give forecast position estimates for that vortex for
+given numerical model.  For the levels 700 & 850 mb, the tracked parameters are:
+Relative vorticity (max), wind magnitude (min), and geopotential height (min). 
+Also tracked is the min in the MSLP. So many parameters are tracked in order to provide more accurate 
+position estimates for weaker storms, which often have poorly defined structures/centers.
+Currently, the system is set up to be able to process GRIB input data files from the GFS, MRF, UKMET, GDAS,
+ECMWF, NGM, NAM and FNMOC/NAVGEM models. Two 1-line files are  output from this program, both containing the 
+forecast fix positions that the  tracker has obtained.  One of these  output files contains the positions at 
+every 12 hours from forecast hour 0 to the end of the forecast. The other file is in ATCF format, which is 
+the particular format needed by the Tropical Prediction Center, and provides the positions at forecast hours
+12, 24, 36, 48 and 72, plus the maximum wind near the storm center at each of those forecast hours.
+
+For more documentation on how the tracker runs in genesis mode or the wind radii and axisymmetric diagnostic schemes please see genesisdoc.md and radiidoc.md, respectively.
+
+## Dependices, Installation, Compiling, Running
+⚠️ IN CONSTRUCTION ⚠️
+
+The following external libraries are required for buildig the vortex tracker:
+  * NETCDF and Fortran (77/90)
+  * Fortran standard compiler
+  * PNG
+  * Jasper
+  * Zlib
+  * NCEP libraries: g2, bacio, w3nco, w3emc
+
+### Instructions for building & installing with cmake:
+
+As of right now, building & installing with cmake is only setup to work on RDHPCS systems Hera, Jet, and 
+Orion. 
+If on one of these systems :
+  1.      module load cmake
+  2.      cd src/
+  3.      ./build_all_cmake.sh
+
+❗ Stay tuned for building instructions for other systems ❗
+
+### Running Vortex Tracker
+
+ ❗ COMING SOON ❗