generated from NOAA-OWP/owp-open-source-project-template
-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from CIROH-UA/add_lstm_extern
Add LSTM submodule to ngen repository in extern/lstm
- Loading branch information
Showing
3 changed files
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |