Merge pull request #148 from nsidc/match-ecdrv4-doc

Add CHANGELOG and dev doc note about `match-cdrv4`
nsidc · Sep 16, 2024 · 9e7bfdd · 9e7bfdd
2 parents 87271ec + 189883a
commit 9e7bfdd
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+# match-cdrv4 (commit 87271ec)
+
+* `match-cdrv4` tag marks the commit at which this code supports replicating the
+  behavior of CDRv4 at 25km resolution. This is useful for comparison
+  purposes. Future commits will remove support for producing CDRv4 in favor of
+  the improvements and bugfixes provided by CDRv5.
+
 # v0.2.0
 
 * Produce 25km CDR instead of 12.5km.

diff --git a/doc/development.md b/doc/development.md
@@ -163,3 +163,14 @@ When making a new release of G02202 based on this code:
   archive containing the `seaice_ecdr`, `pm_icecon`, and `pm_tb_data`
   repositories and ancillary data. This `.zip` package should then be sent to
   NOAA for archival.
+
+
+### Replicating CDRv4 results
+
+There are a number of improvements and bug fixes that have been made since the
+CDRv4. To produce CDRv4-compatible results with this code, checkout the
+`match-cdrv4` tag (commit 87271ec):
+
+```
+git checkout match-cdrv4
+```