From edc24ca09189e7c16c5107b7573d9c95dd130ff0 Mon Sep 17 00:00:00 2001
From: Azadeh Gholoubi <51101867+azadeh-gh@users.noreply.github.com>
Date: Tue, 20 Feb 2024 18:12:40 -0500
Subject: [PATCH] Update README.md

---
 ush/obsErrorAssignmentTool/README.md | 37 +++++++++++++++++++++++++---
 1 file changed, 34 insertions(+), 3 deletions(-)

diff --git a/ush/obsErrorAssignmentTool/README.md b/ush/obsErrorAssignmentTool/README.md
index 8ba2e66..7896012 100644
--- a/ush/obsErrorAssignmentTool/README.md
+++ b/ush/obsErrorAssignmentTool/README.md
@@ -1,3 +1,34 @@
-2/20/2024
-Azadeh Gholoubi
-ObsErrorAssignmentTool
+## 2/20/2024
+## Azadeh Gholoubi
+# Python Tool for Observation Error Assignment
+
+## Overview
+This tool automates the estimation of observation error parameters. It consists of a shell script, `run_error_model_estimate.sh`, which invokes the `ObsErrorAssignment.py` Python script to perform the following tasks:
+
+1. Compute mean cloud amount and first guess standard deviation.
+2. Generate four plots:
+   - Mean cloud amount vs. first guess departure standard deviation
+   - Number of observations in each defined bin of mean cloud amount
+   - Un-normalized and normalized first guess departure
+   - Histogram of Errors at each bin
+3. Compute error parameters (`error_cld`, `error_clr`, `clw_clr`, and `clw_cld`) and create CSV files for each channel.
+
+## Usage
+Before running the script, the user needs to specify certain parameters in `run_error_model_estimate.sh`:
+
+- `config_path`: Directory for input config .nc files
+- `output_path`: Path to output files
+- `sensor`: Sensor name
+- `Channels`: Channel numbers (enclosed in quotes, separated by commas, e.g., "1,2,3,5")
+- `bin_size`: Size of bin for plotting (default=0.05)
+- `bindir`: Output file name
+- `qc_flag`: QC flag for filtering (default=0)
+- `PyGSI`: Path to the PyGSI branch on Hera or Orion to load the proper environment
+
+To view all the required inputs for this tool, use the following command:
+
+```bash
+python ObsErrorAssignment.py -h
+
+
+