-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README.md Updating a very old README.md file. Extended documentation will be found in the Wiki tab on Github. * update README.md
- Loading branch information
1 parent
f253613
commit 2e9bcc5
Showing
1 changed file
with
28 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/#/). |