New release 0.8.6

wxguy · wxguy · commit b876e6667ab3 · 2023-02-05T22:47:39.000+05:30
Included '--ulevels' command line argument/ option to allow user to specify their own list of levels. It should be between 50-1000hPa levels only.

Removed `_version.py` file from the source. This would be created automatically during build process.

Update to Documentation to reflect two added options.
diff --git a/.github/workflows/release-pip.yaml b/.github/workflows/release-pip.yaml
@@ -18,8 +18,8 @@ jobs:
         pip install setuptools wheel twine setuptools-git-versioning build
     - name: Build Package
       run: |
-        #echo "Updating '_version' file with: '$(setuptools-git-versioning)'..."
-        #echo -e "# Generated by wrfplot build file. Do not edit it manually...\n__version__ = version = '$(setuptools-git-versioning)'" > _version.py
+        echo "Updating '_version' file with: '$(setuptools-git-versioning)'..."
+        echo -e "# Generated by wrfplot build process. Do not edit it manually...\n__version__ = version = '$(setuptools-git-versioning)'" > _version.py
         python -m build --sdist
     - name: Publish to PyPi
       uses: pypa/gh-action-pypi-publish@release/v1.5
diff --git a/.gitignore b/.gitignore
@@ -12,6 +12,9 @@ install_env.txt
 dev/
 test/
 release_check_list*
+
+# Version file is generated during release process in GitHub
+_version.py
 # docs/
 
 # Distribution / packaging
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -2,6 +2,12 @@
 History
 =======
 
+v0.8.6 (2023-02-05)
+------------------------
+* Included '--ulevels' command line argument/ option to allow user to specify their own list of levels. It should be between 50-1000hPa levels only.
+* Removed `_version.py` file from the source. This would be created automatically during build process.
+* Update to Documentation to reflect two added options.
+
 v0.8.0 (2023-02-02)
 ------------------------
 * Included '--cmap' command line argument/ option to allow user to specify their own colormap (list supported by wrfplot )
diff --git a/README.md b/README.md
@@ -1,12 +1,14 @@
-[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+Application License [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 
-[![Linux](https://svgshare.com/i/Zhy.svg)](https://svgshare.com/i/Zhy.svg) [![Windows](https://svgshare.com/i/ZhY.svg)](https://svgshare.com/i/ZhY.svg)
+Works on both Linux [![Linux](https://svgshare.com/i/Zhy.svg)](https://svgshare.com/i/Zhy.svg) and Windows [![Windows](https://svgshare.com/i/ZhY.svg)](https://svgshare.com/i/ZhY.svg). Mac OS [![macOS](https://svgshare.com/i/ZjP.svg)](https://svgshare.com/i/ZjP.svg) support is available via `conda`.
 
-[![Documentation Status](https://readthedocs.org/projects/wrfplot/badge/?version=latest)](https://wrfplot.readthedocs.io/en/latest/?badge=latest)
+Status of Documentation [![Documentation Status](https://readthedocs.org/projects/wrfplot/badge/?version=latest)](https://wrfplot.readthedocs.io/en/latest/?badge=latest)
 
-[![PyPI Version](https://badge.fury.io/py/ansicolortags.svg)](https://pypi.python.org/pypi/wrfplot/) [![PyPi Downloads](https://static.pepy.tech/personalized-badge/wrfplot?period=total&units=international_system&left_color=blue&right_color=brightgreen&left_text=Pip%20Downloads)](https://pepy.tech/project/wrfplot)
+Details of PyPi package [![PyPI Version](https://badge.fury.io/py/ansicolortags.svg)](https://pypi.python.org/pypi/wrfplot/) [![PyPi Downloads](https://static.pepy.tech/personalized-badge/wrfplot?period=total&units=international_system&left_color=blue&right_color=brightgreen&left_text=Pip%20Downloads)](https://pepy.tech/project/wrfplot)
 
-![Build and Release](https://github.com/wxguy/wrfplot/actions/workflows/release-github.yaml/badge.svg)  ![PyPi Package](https://github.com/wxguy/wrfplot/actions/workflows/release-pip.yaml/badge.svg)
+Status of builds ![Build and Release](https://github.com/wxguy/wrfplot/actions/workflows/release-github.yaml/badge.svg)  ![PyPi Package](https://github.com/wxguy/wrfplot/actions/workflows/release-pip.yaml/badge.svg)
+
+Conda details ![Conda Version](https://anaconda.org/conda-forge/wrfplot/badges/version.svg)  ![Last updated on](https://anaconda.org/conda-forge/wrfplot/badges/latest_release_date.svg) ![Works on Windows, Linux and Mac](https://anaconda.org/conda-forge/wrfplot/badges/platforms.svg) ![Download Counts](https://anaconda.org/conda-forge/wrfplot/badges/downloads.svg)
 
 ## About wrfplot
 
@@ -22,11 +24,26 @@ Documentation of this project is located at https://wrfplot.readthedocs.io.
 
 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 which does not much tweaking for your publication.
 
-## Installation
+## Installation on all Platforms (Windows, Linux and Mac OS)
+
+Support for all platforms is provided through `conda-forge`. If you have already conda installed, then following command is enough to install `wrfplot`:
+
+```
+conda install -c cond-forge wrfplot
+```
+Check your installation by typing following command which should show the version number:
+
+```
+wrfplot --version
+0.1.0
+```
+
 
-Since it is intended to be used as command line, the application is distributed as stand-alone on both Linux and Windows. You must download the correct version of application installer or setup file. Both are described below:
+## Binary (standalone) Installation
 
-### Windows
+Since it is intended to be used as command line, the application is also distributed as stand-alone on both Linux and Windows. You must download the correct version of application installer or setup file. Both are described below:
+
+### Windows Only
 
 Go to https://github.com/wxguy/wrfplot/releases and look for latest release. The Windows setup executable will have name `wrfplot-windows-64bit.exe`. Click on the link and download it to local disk. The rest of the installation procedure is same as you do for any other windows setup files. Once installed Check if installation is successful by typing following command in `cmd` window which should not produce any errors:
 
@@ -35,9 +52,9 @@ wrfplot --version
 0.1.0
 ```
 
-### Linux
+### Linux Only
 
- Go to https://github.com/wxguy/wrfplot/releases and look for 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`):
+ You must have at least `Ubuntu 22.04` or above for this to work. There is no additional packages or admin rights are required to install this package. Go to https://github.com/wxguy/wrfplot/releases and look for 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`):
 
  ```
  bash ~/Downloads/wrfplot-linux-64bit.run
@@ -65,6 +82,10 @@ wrfplot --version
 0.1.0
 ```
 
+### Mac OS Only
+
+At the moment, Mac OS support is not available in binary format. You can install `wrfplot` using method mentioned above.
+
 ## How to use?
 
 Please refer to https://wrfplot.readthedocs.io for complete documentation on how to use `wrfplot` application.
@@ -74,12 +95,12 @@ Please refer to https://wrfplot.readthedocs.io for complete documentation on how
 
 Add following command line options:
 
-* `--levels `   :   To plot upper level data as per user defined levels
-* `--cmap`      :   Use user provided colour map
-* `--contours`  :   Control contour levels
+* ~~`--cmap`      :   Use user provided colour map~~
+* ~~`--ulevels `   :   To plot upper level data as per user defined upper levels~~
+* `--clevels `   :   Control contour levels
 * `--animation` :   Create animation for specific variable(s) in GIF for max compatibility
-* `--fig-format`:   Save image in specific file format
-* `--list-fig-format`   :   List all supported image file format
+* `--save-format`:   Save image in specific file format
+* `--list-save-format`   :   List all supported image file format
 * `--title`     :   Custom title for the plot
 * `--title-font-size`   :   Specify title font size
 
diff --git a/build_exe.py b/build_exe.py
@@ -58,6 +58,7 @@
     geos_trgt_dir = os.path.join("shapely", "DLLs", "\\")
     compiler = "--mingw64"
     nutika_exe_name = 'wrfplot.exe'  # os.path.join(output_dir, 'wrfplot.dist', 'wrfplot.exe')
+    frozen_version_file = os.path.join(project_root, "build", "windows", "wrfplot", "_version.py")
 
 elif platform.system() == "Linux":
     output_dir = os.path.join(project_root, 'build', 'linux')
@@ -68,6 +69,7 @@
     geos_trgt_dir = "shapely/.libs/"
     compiler = ""
     nutika_exe_name =  'wrfplot' #os.path.join(output_dir, 'wrfplot.dist', 'wrfplot')
+    frozen_version_file = os.path.join(project_root, "build", "linux", "wrfplot", "_version.py")
 
 # Tested on Miniconda Python 3.10.4
 # This is the place one need to be carefull. For wrfplot project, netcdf, shapely and pyproj modules were not detected
@@ -351,6 +353,7 @@ def main():
             execute_cmd("pyinstaller --noconfirm --distpath " + output_dir + " wrfplot.spec")
 
         # test_wrfplt_exe()
+        update_verion()
         create_makeself()
 
 
@@ -374,14 +377,15 @@ def build_sdist():
     else:
         sys.exit("Failure to build source distribution package.\n Please correct the issue and build the executable again.")
 
-def update_varion():
+def update_verion():
     if which("setuptools-git-versioning"):
         VERSION = subprocess.check_output(["setuptools-git-versioning"]).strip().decode("utf-8").replace("v", "")
     else:
         VERSION = subprocess.check_output(["git", "describe", "--tags"]).strip().decode("utf-8").replace("v", "")
     
     print("Updating varion information to file with :", VERSION)
-    with open(os.path.join(project_root, "wrfplot", "_version.py"), "w") as _file:
+    print("Version information will be updated in : " + frozen_version_file)
+    with open(frozen_version_file, "w") as _file:
         _file.write("# Generated by wrfplot build file. Do not edit it manually...\n")
         _file.write("__version__ = version = " + quote(VERSION))
         _file.write('\n')
@@ -394,7 +398,6 @@ def update_varion():
         compile_module = "pyinstaller"
     # Check if we are running the script in correct filesystem
     check_fs()
-    update_varion()
     clean_dirs()
     build_sdist()
     # sys.exit()
diff --git a/docs/_static/images/T2_cmap-example.png b/docs/_static/images/T2_cmap-example.png
diff --git a/docs/_static/images/u_winds_400hpa.png b/docs/_static/images/u_winds_400hpa.png
diff --git a/docs/examples.rst b/docs/examples.rst
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -2,6 +2,9 @@
 How to use wrfplot
 ==================
 
+Basic Usage
+~~~~~~~~~~~~
+
 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  following command in terminal::
 
 	$ wrfplot --list-vars
@@ -53,7 +56,7 @@ Looking at the above output, you will understand that it looks similar to what i
 
 Now, lets go ahead and start plotting the variable "2m Relative Humidity" named as "rh2"::
 
-	python wrfplot.py --input ../../test/wrfout_d01_2016-03-30_00_00_00 --var "rh2" --output ~/Documents/wrfplot_output
+	python wrfplot.py --input ../../test/wrfout_d01_2016-03-30_00_00_00 --vars "rh2" --output ~/Documents/wrfplot_output
                                                                                                                          
 	*** Initialising plotting for variable : "rh2" ***
 
@@ -66,12 +69,27 @@ In the above command, we have provided three options where:
 
 * ``--input`` is the path to WRF model output NetCDF file.
 * ``--output`` is the path to output directory where the plotted images are required to be saved. If the path to directory does not exist, then wrfplot will try to create it.
-* ``--var`` is the variable name we need the wrfplot to plot.
+* ``--vars`` is the variable name we need the wrfplot to plot.
 
 When the wrfplot start plotting the variable for all times, you can see the progress of operation through progress bar at the bottom of terminal. The plotted output for variable will look like below:
 
 .. image:: _static/images/rh2_30-03-2016_12_00.png
   :width: 800
   :alt: Alternative text
 
-You can see from the above image that all the required fields such as title, colour map, colour bar range, model cycle and forecast validity are automatically picked up by wrfplot. Now onwards, you can only change the ``--var`` with different name to plot new variables.
+You can see from the above image that all the required fields such as title, colour map, colour bar range, model cycle and forecast validity are automatically picked up by wrfplot. Now onwards, you can only change the ``--vars`` with different name to plot new variables.
+
+Plotting Upper Atmospheric Variables
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`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 & 200hPa``. The upper levels can be controlled using ``--ulevels`` though. If you want to plot upper winds, you can specify the variable with following command::
+
+	$ wrfplot --vars "u_winds" --input ../../test/wrfout_d01_2016-03-30_00_00_00 --vars "rh2" --output ~/Documents/wrfplot_output
+
+Note that the wrf output file resolution is very high. However, `wrfplot` automatically calculates the correct resolution and size to fit the wind barbs within plot area. The above command would produce the plot as indicated above. Only 400hPa level plot is indicated below to ensure that page is not loaded with only images.
+
+.. image:: _static/images/u_winds_400hpa.png
+  :width: 800
+  :alt: Alternative text
+
+You can also control various par of plotting with additional command line options. They are described in next page.
diff --git a/tests/test.py b/tests/test.py
@@ -64,6 +64,16 @@ def plot_upper(input_path, output_dir):
         print('Failed to complete upper atmospheric plots successfully...')
         return False
 
+def test(input_path, output_dir):
+    cmd_options = [wrfplot_path, '--vars', 'u_winds,dummy,u_rh', '--ulevels', '900,450,dummy', '--input', input_path, '--output', output_dir]
+    if os.system('python ' + " ".join(cmd_options)) == 0:
+        print('Successfully completed upper atmospheric plots...')
+        return True
+    else:
+        print('Failed to complete upper atmospheric plots successfully...')
+        return False
+    
+
 if __name__ == "__main__":
     test_file_path = os.path.realpath(__file__)
     wrf_input_path = os.path.join(os.path.dirname(test_file_path), '..', '..', '..', 'WRF_TEST_FILES', 'wrfout_d02_2016-03-31_00_00_00')
@@ -74,4 +84,5 @@ def plot_upper(input_path, output_dir):
     clean_cartopy_data_dir()
     plot_sfc_data(input_path=wrf_input_path, output_dir=output_plot_dir)
     plot_upper(input_path=wrf_input_path, output_dir=output_plot_dir)
+    test(input_path=wrf_input_path, output_dir=output_plot_dir)
     
diff --git a/wrfplot/_version.py b/wrfplot/_version.py
@@ -1,2 +1,2 @@
 # Generated by wrfplot build file. Do not edit it manually...
-__version__ = version = "0.8.1.post1+git.65aea851.dirty"
+__version__ = version = "0.8.5.post0+git.dd6dcb3e.dirty"
diff --git a/wrfplot/arguments.py b/wrfplot/arguments.py
@@ -160,4 +160,49 @@ def validate_cmap(cmap):
     else:
         print("\nUsing user provided colormap :", utils.quote(cmap))
 
-        return cmap
+        return cmap
+
+
+def valid_range(ulevel):
+    """ Validate input pressure level """
+    if ulevel > 1000:
+        print("Upper level" + utils.quote(str(ulevel)) + " can not be more than 1000")
+        return False
+    elif ulevel < 50:
+        print("Upper level" + utils.quote(str(ulevel)) + " can not be less than 1000")
+        return False
+    else:
+        return True
+
+        
+def validate_ulevels(ulevels):
+    """Validate user provided upper atmospheric levels
+    
+    Args:
+        ulevels (list): list of levels provided by user
+    Results:
+        list:   List of filtered levels. None is returned if nothing compatible with wrfplot
+    """
+    filtered_ulevels = []
+    if ',' not in str(ulevels):
+        if ulevels.isdigit():
+            if valid_range(float(ulevels)) is True:
+                filtered_ulevels.append(float(ulevels))
+        elif isinstance(ulevels, str):
+            print("Upper level can not have string in it. Omitting " + utils.quote(ulevels))
+    else:
+        for level in ulevels.split(','):
+            if level.isdigit():
+                if valid_range(float(level)) is True:
+                    filtered_ulevels.append(float(level))
+            elif isinstance(level, str):
+                print("Upper level can not have string in it. Omitting " + utils.quote(level))
+
+    if len(filtered_ulevels) > 0:
+        output_str_lst = [str(x) for x in filtered_ulevels]
+        print("Using user provided upper level(s) : " + utils.quote(",".join(output_str_lst)))
+        return filtered_ulevels
+    else:
+        print("\nNone of the levels are valid upper levels.")
+        print("Defaulting to levels '925, 850, 700, 600, 500, 400, 300 & 200hPa' supported by wrfplot.")
+        return None
diff --git a/wrfplot/wrfplot.py b/wrfplot/wrfplot.py
@@ -305,7 +305,7 @@ def plot_upper(self):
                 if self.U is not None and self.V is not None:
                     self.U = interplevel(u_var_u_data, pressure, self.ulevel)
                     self.V = interplevel(u_var_v_data, pressure, self.ulevel)
-                tqdm.write("\t  at level" + utils.quote(self.ulevel))
+                tqdm.write("\t  at level " + utils.quote(self.ulevel) + " hPa")
                 pbar_lvl.set_description("Plotting Level :", refresh=True)
                 self.plot_wrf_data(_time=_time, index=index, data_plot=self.var_data, level=self.ulevel)
         tqdm.write("\nPlotting of " + utils.quote(self.var) + " completed...\n")
@@ -409,7 +409,7 @@ def _praser():
         "Command line application to plot static WRF model prognostic products..."
     )
     parser = argparse.ArgumentParser(
-        description=prog_name, epilog="\u00a9 J Sundar, wrf.guy@gmail.com, 2022"
+        description=prog_name, epilog="\u00a9 J Sundar, wrf.guy@gmail.com, 2023"
     )
     parser.add_argument(
         "--list-vars", action="store_true", help="List variables supported by wrfplot."
@@ -444,7 +444,7 @@ def _praser():
     parser.add_argument(
         "--list-cmaps",
         action="store_true",
-        help="List colour maps (cmaps) supported by wrfplot.",
+        help="List colour maps (cmaps) supported by wrfplot. Refer https://pratiman-91.github.io/colormaps for information on each colourmaps.",
     )
     parser.add_argument(
         "--cmap",
@@ -453,6 +453,12 @@ def _praser():
         default=False,
         help="Valid colormap name to fill colors. Use '--list-cmaps' option to see list of supported colormaps. Must have minimum 11 colors, else will lead to error.",
     )
+    parser.add_argument(
+        "--ulevels",
+        metavar="<upper-levels>",
+        type=arguments.validate_ulevels,
+        help="Provide custom upper level(s) when plotting upper atmospheric data. Each level is to be seperated by ',' i.e., '925,850,700'. Use '--list-vars' to know list of supported upper level variables.",
+    )
     parser.add_argument(
         "--version",
         action="store_true",
@@ -478,7 +484,7 @@ def main():
         file = fileio.FileIO(args.input)
         if file.is_wrf():
             wrfplt = Wrfplot(
-                input_path=args.input, output_path=args.output, dpi=args.dpi, cmap=args.cmap
+                input_path=args.input, output_path=args.output, dpi=args.dpi, cmap=args.cmap, ulevels=args.ulevels
             )
             try:
                 wrfplt.read_file(args.input)

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`# Generated by wrfplot build file. Do not edit it manually...`
`2`		`-__version__ = version = "0.8.1.post1+git.65aea851.dirty"`
	`2`	`+__version__ = version = "0.8.5.post0+git.dd6dcb3e.dirty"`