Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add LSTM submodule to ngen repository in extern/lstm #895

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -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
27 changes: 27 additions & 0 deletions extern/lstm/README.md
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions extern/lstm/lstm
Submodule lstm added at 44a16c
Loading