Improvements in documentation

Author: wxguy

docs/authors.md

@@ -6,4 +6,5 @@ None yet. Why not be the first?
 
 ### Other contributors
 
-Those who have given their feedback and reported bugs can be found in [https://github.com/wxguy/wrfplot/issues](https://github.com/wxguy/wrfplot/issues).
+Those who have given their feedback and reported bugs can be found in
+[https://github.com/wxguy/wrfplot/issues](https://github.com/wxguy/wrfplot/issues).

docs/colormaps.md

@@ -1,27 +1,42 @@
 ## About wrfplot
 
-`wrfplot` is a Command Line application written in Python Programming Language to plot set of diagnostic forecast variables from Weather Research and Forecasting (WRF) atmospheric model output file. Though, WRF model output files are simple NetCDF, it requires one to install various software and libraries to plot even a single variable. Python has many modules that can deal with WRF model output data set. However, setting up these libraries, plotting variables through reading a lot of documentation is a tedious process. wrfplot aims to fill this gap by proving an application that is easy to install and use.
-
-The idea of developing `wrfplot` came to my mind as I frequently revisit the same code base again and again to tweak a few lines of code to get changes in final plots. Therefore, I was looking for a command line application that would help me to generate a common WRF model forecast images by providing appropriate command line options. I could not find any and hence created one.
+`wrfplot` is a Command Line application, written in Python programming language, 
+to plot a set of diagnostic forecast variables from the Weather Research and 
+Forecasting (WRF) atmospheric model output file. 
+Though, WRF model output files are ust a NetCDF file,
+it requires one to install various software and libraries to plot a single variable.
+Python has many modules that can deal with WRF model output data set.
+However, setting up these libraries, plotting variables through reading a lot of documentation is a tedious process.
+`wrfplot` aims to fill this gap by proving an application that is straightforward to install and use.
+
+The idea of developing `wrfplot` came to my mind as I frequently revisit the same code base again and again to tweak a 
+few lines of code to get changes in final plots.
+Therefore, I was looking for a command line application 
+that would help me to generate a common WRF model forecast images by providing appropriate command line options. 
+I could not find any and hence created one.
 
 ## Use Cases
 
-A typical use case of `wrfplot` would be to include as part of your WRF model run framework to plotting of variables immediately after the model run is completed. The other use case would be to use it for producing publication quality 2D maps that do not have much tweaking for your publication.
+A typical use case of `wrfplot` would be to include as part of your WRF model run framework
+to plotting of variables immediately after the model run is completed. 
+The other use case would be
+to use it for producing publication quality 2D maps that have little tweaking for your publication.
 
 !!! note
 
-    `wrfplot` is a new application. If you find any issues related to plotting variables or documentation, please open an issue in Github as given in [Support](support.md          ) secion.
+    `wrfplot` is a new application. If you find any issues related to plotting variables or documentation, please open an issue in Github as given in [Support](support.md) secion.
 
 
 The best way to explore the application is to read and execute the extensive examples provided in [usage](usage.md) section.
 
 For complete list of options, execute the following command in the terminal or cmd window:
 
-```console
-$ wrfplot --help
+```commandline
+wrfplot --help
 ```
 
 ## Source Code
 
 `wrfplot` is an Open Source application and released under General Public License (GPL) Version 3. 
-The source code of the application can be found at [https://github.com/wxguy/wrfplot](https://github.com/wxguy/wrfplot). 
+The source code of the application can be found at [https://github.com/wxguy/wrfplot](https://github.com/wxguy/wrfplot). 
+

docs/index.md

@@ -3,18 +3,18 @@
 This section briefly guides you to install **_wrfplot_** on a variety of Operating Systems viz., Linux, Windows and macOS.
 
 ## System Requirements
-Here are the following dependencies you should know about before installing wrfplot:
+Here are the following dependencies you should know about before installing `wrfplot`:
 
 * Operating System (Windows): Windows 10 or above. May work on Windows 7/ 8 but not tested.
 
-* Operating System (Linux): Ubuntu 18.04 or above. If you wish to use it on Red Hat or Cent OS based, then it should be versioned 7 or above.
+* Operating System (Linux): Ubuntu 20.04 or above. If you wish to use it on Red Hat or Cent OS based, then it should be versioned 8 or above.
 
 * Architecture: x86_64 or simple called 64bit. **_Don't download if you have 32bit machine_**. It won't work.
 
 ## Install on Windows, Linux and macOS
 
 Support for all platforms is provided through conda-forge.
-If you have already conda installed, then the following command is enough to install wrfplot:
+If you have already conda installed, then the following command is enough to install `wrfplot`:
 
 ```commandline
 conda install -c cond-forge wrfplot
@@ -78,10 +78,10 @@ That’s it. You have successfully installed `wrfplot`.
 
 ### Installation under Linux
 
-Go to [https://github.com/wxguy/wrfplot/releases](https://github.com/wxguy/wrfplot/releases) and look for the latest release. The Linux installer will have name wrfplot-linux-64bit.run. Click on the link and download it to local disk. Thereafter, execute the below command (assuming that the Linux installer is downloaded at ~/Downloads):
+Go to [https://github.com/wxguy/wrfplot/releases](https://github.com/wxguy/wrfplot/releases) and look for the latest release. The Linux installer will have name `wrfplot`-linux-64bit.run. Click on the link and download it to local disk. Thereafter, execute the below command (assuming that the Linux installer is downloaded at ~/Downloads):
 
-```console
-$ bash ~/Downloads/wrfplot-linux-64bit.run
+```commandline
+bash ~/Downloads/wrfplot-linux-64bit.run
 ```
 
 that would produce the output as indicated below:
@@ -103,15 +103,15 @@ Installation completed. Please restart your terminal to continue using wrfplot..
 
 There is no binary distribution made available for macOS at the moment. The support for macOS is provided through miniconda. If you already have miniconda/ anaconda installed, you can execute the following to install `wrfplot`:
 
-```console
-$ conda install -c conda-forge wrfplot
+```commandline
+conda install -c conda-forge wrfplot
 ```
 
 ## Confirm Installation
 
 The easiest way to check the installation is to issue the following command in the terminal:
 
-```console
+```commandline
 wrfplot --help
 ```
 
@@ -154,5 +154,5 @@ options:
 © J Sundar, wrf.guy@gmail.com, 2024
 ```
 
-If you get inbuilt help page of wrfplot, then it is ensured that you have successfully installed wrfplot.
+If you get the inbuilt help page of `wrfplot`, then it is ensured that you have successfully installed `wrfplot`.
 

docs/install.md

@@ -1,5 +1,9 @@
-wrfplot is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version. 
+`wrfplot` is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License 
+as published by the Free Software Foundation, either version 3 of the License, or any later version. 
 
-wrfplot is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+`wrfplot` is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 
+of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
+See the GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License along with wrfplot. If not,   see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU General Public License along with `wrfplot`. 
+If not, see <http://www.gnu.org/licenses/>.

docs/license.md

@@ -1,4 +1,5 @@
-If you encounter any bugs or issues that have not been reported yet, you must open an issue at [https://github.com/wxguy/wrfplot/issues](https://github.com/wxguy/wrfplot/issues).
+If you encounter any bugs or issues that have not been reported yet, you must 
+open an issue at [https://github.com/wxguy/wrfplot/issues](https://github.com/wxguy/wrfplot/issues).
 
 For any other questions or inquiries, feel free to reach out to the project developer(s):
 

docs/support.md

@@ -1,11 +1,11 @@
 ## Basic Usage
 
-The first step in plotting diagnostic variable to find what all variables are supported by wrfplot application. 
+The first step in plotting diagnostic variable to find what all variables are supported by `wrfplot` application.
 This is required as the application would accept variable names only in certain string format. 
 Therefore, you should list and review the name of variable by issuing the following command in the terminal:
 
-```console
-$ wrfplot --list-vars
+```commandline
+wrfplot --list-vars
 ```
 
 Invoking the above command will produce the following output:
@@ -56,16 +56,18 @@ Variable "u_cape"   --> Convective Available Potential Energy ($J kg^{1}$)
 The above console print has two names. One with quote and the other is without. 
 The name within quote such as "slp" is called short variable, and without a quote is called long variable. 
 You can read through a list to take note of what parameter you want to plot. 
-For example, if you need to plot `2m Relative Humidity`, then you need to remember the sort variable name in the first quote “” i.e, `“rh2”`. 
-With this, we will proceed ahead to plot “rh2” variable. To plot any variable, there are minimum three arguments required to be provided. 
-They are `--vars`, `--input` and `--output`. Details of these would be discussed later.
+For example, if you need to plot `2m Relative Humidity`, then you need to remember the sort variable name in the first 
+quote `“”` i.e, `“rh2”`. With this, we will proceed ahead to plot “rh2” variable. To plot any variable, 
+there are minimum three arguments required to be provided. They are `--vars`, `--input` and `--output`. 
+Details of these would be discussed later.
 
 ## Plotting Surface Variable
 
-All the variables which does not start with `u_` string are surface variable. Now, let's go ahead and start plotting the variable “2m Relative Humidity” named as “rh2”:
+All the variables which does not start with `u_` string are surface variable. 
+Now, let's go ahead and start plotting the variable `“2m Relative Humidity”` named as `“rh2”`:
 
-```console
-$ wrfplot --vars "rh2" --input ../../test/wrfout_data/wrfout_d01_2021-05-13_00_00_00 --output ../../test/wrfout_data/output_images
+```commandline
+wrfplot --vars "rh2" --input ../../test/wrfout_data/wrfout_d01_2021-05-13_00_00_00 --output ../../test/wrfout_data/output_images
 ```
 
 Where:
@@ -102,13 +104,13 @@ The plotted output for variable will look like below:
 
 ## Plotting Upper Atmospheric Variables
 
-`wrfplot` supports a few upper atmospheric variables. These variables are indicated with u_ tag for ease of identification. 
+`wrfplot` supports a few upper atmospheric variables. These variables are indicated with `u_` tag for ease of identification. 
 By default, the plot for upper atmospheric variables would be plotted for `925`, `850`, `700`, `600`, `500`, `400`, `300` & `200` hPa. 
 The upper levels can be controlled using `--ulevels` though.
 If you want to plot upper winds, you can specify the variable with the following command:
 
-```console
-$ wrfplot --vars "u_winds" --input ../../test/wrfout_data/wrfout_d01_2021-05-13_00_00_00 --output ../../test/wrfout_data/output_images
+```commandline
+wrfplot --vars "u_winds" --input ../../test/wrfout_data/wrfout_d01_2021-05-13_00_00_00 --output ../../test/wrfout_data/output_images
 ```
 
 <figure markdown="span">
@@ -122,8 +124,8 @@ When plotting upper level variable, `wrfplot` will plot all the predefined level
 You can control the level at which variable is required to be plotted using `--ulevels` argument. 
 For example, if you need to plot at `800` and `750` hpa levels only, then you can apply the following command:
 
-```console
-$ wrfplot --vars "u_winds" --ulevels "800,750" --input ../../test/wrfout_data/wrfout_d01_2021-05-13_00_00_00 --output ../../test/wrfout_data/output_images
+```commandline
+wrfplot --vars "u_winds" --ulevels "800,750" --input ../../test/wrfout_data/wrfout_d01_2021-05-13_00_00_00 --output ../../test/wrfout_data/output_images
 ```
 
 Remember that the level values are to be separated by `,`. That should produce the following output in the terminal:
@@ -161,8 +163,8 @@ Plotting process completed. It took 0H:0M:6.948402S
 
 You can also create an animation of your plots using `--gif` option. Example command is given below:
 
-```console
-$ wrfplot --vars "rh2" --gif --input ../../test/wrfout_data/wrfout_d01_2021-05-13_00_00_00 --output ../../test/wrfout_data/output_images 
+```commandline
+wrfplot --vars "rh2" --gif --input ../../test/wrfout_data/wrfout_d01_2021-05-13_00_00_00 --output ../../test/wrfout_data/output_images 
 ```
 
 This would produce an animated `gif` image as shown below:
@@ -176,8 +178,8 @@ This would produce an animated `gif` image as shown below:
 
 By default, the speed of the animation is kept as `0.5` sec. If you wish to increase or decrease the speed, you can do so by with `--gif-speed` option as indicated below where speed is increased to `0.25` sec:
 
-```console
-$ wrfplot --vars "rh2" --gif --gif-speed 0.25 --input ../../test/wrfout_data/wrfout_d01_2021-05-13_00_00_00 --output ../../test/wrfout_data/output_images 
+```commandline
+wrfplot --vars "rh2" --gif --gif-speed 0.25 --input ../../test/wrfout_data/wrfout_d01_2021-05-13_00_00_00 --output ../../test/wrfout_data/output_images 
 ```
 
 This would increase the speed of animation as shown in the sample image file.
@@ -196,8 +198,8 @@ Levels are to be in ascending order and separated by ','.
 For example, `24,26,28,30,32,34,36`.
 Example plot to change temperature level to highlight the temperature range of interest will be as follows:
 
-```console
-$ wrfplot --vars "rh2" --clevels '0,10,20,30,32,34,36,38,40,42,44,46' --input ../../test/wrfout_data/wrfout_d01_2021-05-13_00_00_00 --output ../../test/wrfout_data/output_images 
+```commandline
+wrfplot --vars "rh2" --clevels '0,10,20,30,32,34,36,38,40,42,44,46' --input ../../test/wrfout_data/wrfout_d01_2021-05-13_00_00_00 --output ../../test/wrfout_data/output_images 
 ```
 
 After executing the command with `--clevels` argument, the plot would look like this:
@@ -213,4 +215,3 @@ this can be compared with the default clevels set by the `wrfplot` as shown belo
   ![Image title](static/images/T2_13-05-2021_17_30.png)
       <figcaption>T2 Plot with Default `--clevels` Option</figcaption>
 </figure>
-

docs/usage.md

@@ -1,6 +1,9 @@
 # Supported Variables
 
-This page contains the list of supported variables by wrfplot. You can see the same list from your terminal by invoking `wrfplot --list-vars` command any time. The variable name starting with `u_` is upper atmospheric data at standard Pressure levels `925`, `850`, `700`, `600`, `500`, `400`, `300` and `200`. How to use the variable name (first column) will be discussed in the next page.
+This page contains the list of supported variables by wrfplot. You can see the same list from your terminal by 
+invoking `wrfplot --list-vars` command any time. The variable name starting with `u_` is upper atmospheric data at 
+standard pressure levels of `925`, `850`, `700`, `600`, `500`, `400`, `300` and `200` hPa. How to use the variable 
+name (first column) will be discussed in the next page.
 
 |  Name of Variable  |             Description with unit              |
 |:------------------:|:----------------------------------------------:|    

docs/variable-list.md docs/variables.md

@@ -5,11 +5,11 @@ site_author: 'J Sundar'
 site_url: https://wxguy.github.io/wrfplot
 
 # Repository
-repo_name: 'wrfplot/wrfplot'
+repo_name: 'wxguy/wrfplot'
 repo_url: 'https://github.com/wxguy/wrfplot'
 
 # Copyright
-copyright: 'Copyright 2024 J Sundar'
+copyright: 'Copyright © 2024 J Sundar'
 
 # Markdown extensions
 markdown_extensions:
@@ -46,7 +46,7 @@ theme:
 nav:
   - Home: index.md
   - Installation: install.md
-  - Variables : variable-list.md
+  - Variables : variables.md
   - Usage: usage.md
   - Colormaps: colormaps.md
   - Support: support.md