Create README.md

NOAA-EMC · Apr 15, 2024 · 980a149 · 980a149
1 parent f813d84
commit 980a149
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,8 @@
+# JCB Algorithms
+
+## Overview
+This repository contains the algorithm YAML files for the JEDI Configuration Builder. These YAML files contain the high level configuration structure that is prescribed by the JEDI data assimilation system.
+
+## Installation
+This repo is typically installed with the main JEDI Configuration Builder (JCB) repository. It is a submodule of that system. Alternatively this repo may be cloned into another workflow repository. The default path used by JCB to search for algorithms can be overridden with another path.
+