From 2e9bcc55824dd2a3216e04f98d8811b1e994b392 Mon Sep 17 00:00:00 2001
From: kevindougherty-noaa
 <69815622+kevindougherty-noaa@users.noreply.github.com>
Date: Tue, 9 May 2023 10:01:17 -0400
Subject: [PATCH] Update README.md (#144)

* Update README.md

Updating a very old README.md file. Extended documentation will be found in the Wiki tab on Github.

* update README.md
---
 README.md | 74 +++++++++++++++++++++----------------------------------
 1 file changed, 28 insertions(+), 46 deletions(-)

diff --git a/README.md b/README.md
index 1070c74..70bb855 100644
--- a/README.md
+++ b/README.md
@@ -1,50 +1,32 @@
-__Kevin Dougherty__
 __September 2020__
 
+__Kevin Dougherty__
 
 # PyGSI
-Scripts used to validate GSI diagnostic files for JEDI
-
-
-# Anaconda Environment
-> Please read the documents for managing environments.  
-> Reference: https://github.com/Unidata/unidata-users-workshop  
-> Reference: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html
-> Reference: https://www.youtube.com/watch?v=15DNH25UCi0
-
-I installed the Anaconda python distribution and created a new environment using the 'environment.yml' file provided in this directory. The name of the environment is DA_Diags. You can copy the the .yml file and run the following command in your terminal
-
-    conda env create -f ./environment.yml
-    
-On a windows computer, to activate the `DA_Diags` environment, do this in the Windows Command Prompt:
-
-    activate DA_Diags
-
-Or, if you are in the PowerShell
-
-    cmd
-    activate DA_Diags
-
-If you are using a `bash` shell in Linux:
-
-    conda init bash  # Only need to do this once to initialize the correct shell
-    conda activate DA_Diags
-
-If you are using a `tcsh` shell in Linux:
-
-    conda init tsch  # Only need to do this once to initialize the correct shell
-    conda activate DA_Diags
-
-
-## Update environment
-Deactivate the environment
-
-    conda deactivate DA_Diags
-
-Update the environment.yml file, and update the conda environment
-
-    conda env update -f environment.yml
-
-List all the available environments
-
-    conda info --envs
+PyGSI is a collection of tools that read, filter, and plot diagnostic GSI netCDF4 files. 
+
+# Environment
+
+## On Supported Platforms
+To load the proper environment when working on Hera, use the following commands:
+```
+cd PyGSI
+module use modulefiles
+module load PyGSI/hera
+```
+
+To load the environment on Orion, use the following commands:
+```
+cd PyGSI
+module use modulefiles
+module load PyGSI/orion
+```
+
+## On Local Machine
+If working on a local machine, users can install PyGSI using pip.
+```
+cd PyGSI
+pip install .
+```
+
+For further instructions on how to use the tools within PyGSI, users can navigate to the documentation page here: [https://noaa-emc.github.io/PyGSI/#/](https://noaa-emc.github.io/PyGSI/#/).