doc: calendar & base date infomation added to time_manager_mod

fixes #826 Added search terms for time manager
NCAR · Mar 6, 2025 · c544fbd · c544fbd
1 parent fd3a813
commit c544fbd
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/assimilation_code/modules/utilities/time_manager_mod.rst b/assimilation_code/modules/utilities/time_manager_mod.rst
@@ -1,3 +1,5 @@
+.. index:: time manager, time manager mod
+
 MODULE time_manager_mod
 =======================
 
@@ -11,6 +13,33 @@ Overview
 | Calendars interpret time intervals in terms of years, months, days. Various calendars commonly in use in the
   scientific community are supported.
 
+Available calendars
+-------------------
+
+The following calendars are available in DART. The base date is used to define the origin of the 
+calendar system. For example, the Gregorian calendar has a base date of January 1, 1601, at 00:00:00. 
+This means that the all the DART time values in days,seconds in the Gregorian calendar are relative to this 
+starting point.
+
++-------------------+-----------+------------+----------+-----------+-------------+-------------+
+| Calendar          | base year | base month | base day | base hour | base minute | base second |
++===================+===========+============+==========+===========+=============+=============+
+| GREGORIAN         | 1601      | 1          | 1        | 0         | 0           | 0           |
++-------------------+-----------+------------+----------+-----------+-------------+-------------+
+| GREGORIAN_MARS    | 1         | 1          | 1        | 0         | 0           | 0           |
++-------------------+-----------+------------+----------+-----------+-------------+-------------+
+| JULIAN            | 1         | 1          | 1        | 0         | 0           | 0           |
++-------------------+-----------+------------+----------+-----------+-------------+-------------+
+| NO_CALENDAR       | not applicable: only time in days, seconds                                |
++-------------------+-----------+------------+----------+-----------+-------------+-------------+
+| NOLEAP            | 1         | 1          | 1        | 0         | 0           | 0           |
++-------------------+-----------+------------+----------+-----------+-------------+-------------+
+| SOLAR_MARS        | 1         | 1          | 1        | 0         | 0           | 0           |
++-------------------+-----------+------------+----------+-----------+-------------+-------------+
+| THIRTY_DAY_MONTHS | 1         | 1          | 1        | 0         | 0           | 0           |
++-------------------+-----------+------------+----------+-----------+-------------+-------------+
+
+
 Other modules used
 ------------------