From 8e8fdcdd204ff4db96bcc24fd7606014ee780f2c Mon Sep 17 00:00:00 2001
From: jmframe <jmframe@crimson.ua.edu>
Date: Fri, 8 Nov 2024 09:15:42 -0500
Subject: [PATCH] Add LSTM submodule to ngen repository in extern/lstm

---
 .gitmodules           |  3 +++
 extern/lstm/README.md | 27 +++++++++++++++++++++++++++
 extern/lstm/lstm      |  1 +
 3 files changed, 31 insertions(+)
 create mode 100644 extern/lstm/README.md
 create mode 160000 extern/lstm/lstm

diff --git a/.gitmodules b/.gitmodules
index dfb26665d9..e031e682e1 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -43,3 +43,6 @@
 [submodule "extern/netcdf-cxx4"]
 	path = extern/netcdf-cxx4/netcdf-cxx4
 	url = https://github.com/Unidata/netcdf-cxx4/
+[submodule "extern/lstm/lstm"]
+	path = extern/lstm/lstm
+	url = https://github.com/CIROH-UA/lstm
diff --git a/extern/lstm/README.md b/extern/lstm/README.md
new file mode 100644
index 0000000000..7f66624af2
--- /dev/null
+++ b/extern/lstm/README.md
@@ -0,0 +1,27 @@
+# LSTM Submodule
+
+## About
+This submodule is linked in from: https://github.com/CIROH-UA/lstm, which is a fork of https://github.com/NOAA-OWP/lstm. This directory follows the template for linking submodules from https://github.com/NOAA-OWP/ngen/edit/master/extern/cfe/.
+
+#### Extra Outer Directory
+
+Currently there are two directory layers beneath the top-level *extern/* directory.  This was done so that certain things used by NGen (i.e., a *CMakeLists.txt* file for building shared library files) can be placed alongside, but not within, the submodule.
+
+## Working with the Submodule
+
+Some simple explanations of several command actions are included below.  To better understand what these things are doing, consult the [Git Submodule documentation](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
+
+### Getting the Latest Changes
+
+There are two steps to getting upstream submodule changes fully 
+  1. fetching and locally checking out the changes from the remote
+  2. committing the new checkout revision for the submodule
+
+To fetch and check out the latest revision (for the [currently used branch](#viewing-the-current-branch)):
+
+    git submodule update --init -- extern/lstm/lstm
+
+To commit the current submodule checkout revision to the CIROH UA NGen repo:
+
+    git add extern/lstm/lstm
+    git commit
diff --git a/extern/lstm/lstm b/extern/lstm/lstm
new file mode 160000
index 0000000000..44a16c18c1
--- /dev/null
+++ b/extern/lstm/lstm
@@ -0,0 +1 @@
+Subproject commit 44a16c18c1b47bb6b5f35f6365878ae9a0a6cee5