update readme

shiv3679 · Sep 5, 2023 · e87d6da · e87d6da
1 parent d06e2ce
commit e87d6da
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -125,6 +125,10 @@ climate_index.pre_process(time_range=None, fill_missing=None, resample_freq=None
     - Other methods, such as `sum`, `max`, etc., can be specified if needed.
     - Use Case: This provides flexibility in how the data is aggregated when resampling, allowing for different types of analysis and interpretation.
 
+#### Additional Checks 
+- **Units Check**: The function also performs a check on the unit of the data variables. It supports 'K' for temperature and 'm' for precipitation.
+- **Special Rule**: If season is 'DJF', and `resample_freq` is not specified, it defaults to 'QS-DEC'.
+
 #### Example Usage
 
 ```python

diff --git a/climate_library/README.md b/climate_library/README.md
@@ -125,6 +125,10 @@ climate_index.pre_process(time_range=None, fill_missing=None, resample_freq=None
     - Other methods, such as `sum`, `max`, etc., can be specified if needed.
     - Use Case: This provides flexibility in how the data is aggregated when resampling, allowing for different types of analysis and interpretation.
 
+#### Additional Checks 
+- **Units Check**: The function also performs a check on the unit of the data variables. It supports 'K' for temperature and 'm' for precipitation.
+- **Special Rule**: If season is 'DJF', and `resample_freq` is not specified, it defaults to 'QS-DEC'.
+
 #### Example Usage
 
 ```python