Merge develop (added tests) to main_v3.0

.github/workflows/trigger_metplus.yaml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - develop
+      - 'main_v[0-9]+.[0-9]+'
     paths-ignore:
       - 'docs/**'
       - '.github/pull_request_template.md'
@@ -16,24 +17,6 @@ jobs:
     name: Trigger METplus testing workflow
     runs-on: ubuntu-latest
     steps:
-      - name: Print GitHub values for reference
-        env:
-          GITHUB_CONTEXT: ${{ toJson(github) }}
-        run: echo "$GITHUB_CONTEXT"
-      - uses: actions/github-script@v7
+      - uses: dtcenter/metplus-action-trigger-use-cases@v1
         with:
-          github-token: ${{ secrets.METPLUS_BOT_TOKEN }}
-          script: |
-            await github.rest.actions.createWorkflowDispatch({
-              owner: 'dtcenter',
-              repo: 'METplus',
-              workflow_id: 'testing.yml',
-              ref: 'develop',
-              inputs: {
-                repository: '${{ github.repository }}',
-                ref: '${{ github.ref }}',
-                actor: '${{ github.actor }}',
-                sha: '${{ github.sha }}',
-                pusher_email: '${{ github.event.pusher.email }}'
-              },
-            });
+          token: ${{ secrets.METPLUS_BOT_TOKEN }}

README.md

@@ -15,10 +15,10 @@ For information about the support provided for releases, see our [Release Suppor
 Instructions for installing the metcalcpy package locally
 ---------------------------------------------------------
 - activate your conda environment (i.e. 'conda activate your-conda-env-name')
-- from within your active conda environment, cd to the METcalcpy/ directory, where you will see the setup.py script
+- from within your active conda environment, cd to the METcalcpy/ directory, where you will see the file pyproject.toml
 - from this directory, run the following on the command line: pip install -e .
 - the -e option stands for editable, which is useful in that you can update your METcalcpy/metcalcpy source without reinstalling it 
-- the . indicates that you should search the current directory for the setup.py script
+- the . indicates that you should search the current directory for the pyproject.toml file.
 
 - use metcalcpy package via import statement:
   - Examples:

docs/Users_Guide/installation.rst

@@ -39,7 +39,7 @@ METcalcpy source code, e.g. `/User/someuser/METcalcpy`.  From this directory, ru
 
 `pip install -e .`
 
-This instructs pip to install the package based on instructios in the setup.py file located in the current directory
+This instructs pip to install the package based on instructions in the pyproject.toml file located in the current directory
 (as indicated by the '.').  The `-e` directs pip to install the package in edit mode, so if one wishes to make changes
 to this source code, the changes are automatically applied without the need to re-install the package.
 

docs/conf.py

@@ -22,7 +22,7 @@
 copyright = '2024, NCAR'
 author = 'UCAR/NCAR, NOAA, CSU/CIRA, and CU/CIRES'
 author_list = 'Fisher, H., C. Kalb, D. Adriaansen, D. Fillmore, M. Win-Gildenmeister, T. Burek, M. Smith, and T. Jensen'
-version = '3.0.0-rc1'
+version = '3.0.0-dev'
 verinfo = version
 release = f'{version}'
 release_year = '2024'

docs/index.rst

@@ -7,6 +7,27 @@ Boulder, CO
 
 .. image:: _static/METplus_banner_photo_web.png
 
+In Memoriam
+-----------
+This coordinated release is dedicated to three remarkable team members 
+we lost in 2024, whose contributions have left an indelible mark on our work. 
+
+To `Tara Jensen <https://dtcenter.org/news/2024/04#3032>`_, 
+for her vision and leadership in creating METplus as well as her 
+dedication, dogged determination, and mentorship that shaped its growth and 
+trajectory, leaving a legacy of innovation in the field of verification.
+
+To `Randy Bullock <https://dtcenter.org/news/2024/04#3031>`_, 
+whose verification libraries formed the basis of MET and 
+whose mathematical brilliance, passion for maps, grid projections, and 
+graphics enriched and inspired new capabilities.
+
+To `Venita Hagerty <https://sites.gsl.noaa.gov/authors/365>`_, 
+for her pivotal expertise, support, and attention to 
+detail that ensured the success of METdataio and METexpress.
+
+Their contributions to METplus continue to guide and inspire us each day.
+
 History
 -------
 

docs/version

@@ -1 +1 @@
-__version__="3.0.0-rc1"
+3.0.0-beta1-dev

metcalcpy/pre_processing/directional_means.py

@@ -8,9 +8,7 @@
  # ============================*
 
 
-
 import numpy as np
-import xarray as xr
 
 
 def zonal_mean(dat,dimvar='longitude'):
@@ -52,10 +50,8 @@ def meridional_mean(dat, lat1, lat2, dimvar='latitude'):
     """
 
     # Check inputs
-    if lat1 > lat2:
-        raise ValueError('lat1 is greater than lat2, but it must be less than lat2')
-    elif lat1 == lat2:
-        raise ValueError('lat1 is equal to lat2, but it must be less than lat2')
+    if lat1 >= lat2:
+        raise ValueError('lat1 is greater than or equal to lat2, but it must be less than lat2')
 
     wgts = np.cos(np.deg2rad(dat[dimvar].where((dat[dimvar] >= lat1) & (dat[dimvar] <= lat2),drop=True)))
 

metcalcpy/util/mode_3d_volrat_statistics.py

@@ -11,6 +11,8 @@
 """
 Program Name: mode_3d_volrat_statistics.py
 """
+import numpy as np
+
 from metcalcpy.util.mode_arearat_statistics import *
 from metcalcpy.util.utils import column_data_by_name_value, THREE_D_DATA_FILTER
 from metcalcpy.util.safe_log import safe_log
@@ -214,7 +216,7 @@ def calculate_3d_volrat_osm_osa(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio OSM/OSA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -244,7 +246,7 @@ def calculate_3d_volrat_osu_osa(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio OSU/OSA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -273,7 +275,7 @@ def calculate_3d_volrat_fsm_asm(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio FSM/ASM calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -303,7 +305,7 @@ def calculate_3d_volrat_osm_asm(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio OSM/ASM calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -333,7 +335,7 @@ def calculate_3d_volrat_osu_asu(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio OSU/ASU calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -363,7 +365,7 @@ def calculate_3d_volrat_fsa_aaa(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio FSA/AAA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -393,7 +395,7 @@ def calculate_3d_volrat_osa_aaa(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio OSA/AAA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -424,7 +426,7 @@ def calculate_3d_volrat_fsa_faa(input_data, columns_names, logger=None):
 
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio FSA/FAA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -454,7 +456,7 @@ def calculate_3d_volrat_fca_faa(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio FCA/FAA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -484,7 +486,7 @@ def calculate_3d_volrat_osa_oaa(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio OSA/OAA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -514,7 +516,7 @@ def calculate_3d_volrat_oca_oaa(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio OCA/OAA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -544,7 +546,7 @@ def calculate_3d_volrat_fca_aca(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio FCA/ACA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -574,7 +576,7 @@ def calculate_3d_volrat_oca_aca(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio OCA/ACA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -605,7 +607,7 @@ def calculate_3d_volrat_fsa_osa(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio FSA/OSA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -636,7 +638,7 @@ def calculate_3d_volrat_osa_fsa(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio OSA/FSA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -666,7 +668,7 @@ def calculate_3d_volrat_aca_asa(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio ACA/ASA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -696,7 +698,7 @@ def calculate_3d_volrat_asa_aca(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio ASA/ACA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -727,7 +729,7 @@ def calculate_3d_volrat_fca_fsa(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio FCA/FSA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -758,7 +760,7 @@ def calculate_3d_volrat_fsa_fca(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio FSA/FCA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -789,7 +791,7 @@ def calculate_3d_volrat_oca_osa(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio OCA/OSA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -820,7 +822,7 @@ def calculate_3d_volrat_osa_oca(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Ratio OSA/OCA calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -850,7 +852,7 @@ def calculate_3d_objvhits(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Hits calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -880,7 +882,7 @@ def calculate_3d_objvmisses(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Renaming columns for 3D Volume Misses calculation.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
 
         safe_log(logger, "debug", "Filtering data based on THREE_D_DATA_FILTER.")
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
@@ -909,7 +911,7 @@ def calculate_3d_objvfas(input_data, columns_names, logger=None):
             or None if some of the data values are missing or invalid
     """
     try:
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
         filtered_data = column_data_by_name_value(input_data, columns_names_new, THREE_D_DATA_FILTER)
         result = calculate_objafas(filtered_data, columns_names_new)
     except Exception as e:
@@ -933,7 +935,7 @@ def calculate_3d_objvcsi(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Starting the renaming of columns.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
         safe_log(logger, "debug", f"Renamed columns: {columns_names_new}")
 
         safe_log(logger, "debug", "Filtering data based on the new column names.")
@@ -964,7 +966,7 @@ def calculate_3d_objvpody(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Starting the renaming of columns.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
         safe_log(logger, "debug", f"Renamed columns: {columns_names_new}")
 
         safe_log(logger, "debug", "Filtering data based on the new column names.")
@@ -995,7 +997,7 @@ def calculate_3d_objvfar(input_data, columns_names, logger=None):
     """
     try:
         safe_log(logger, "debug", "Starting the renaming of columns.")
-        columns_names_new = rename_column(column_names, logger=logger)
+        columns_names_new = rename_column(columns_names, logger=logger)
         safe_log(logger, "debug", f"Renamed columns: {columns_names_new}")
 
         safe_log(logger, "debug", "Filtering data based on the new column names.")
@@ -1027,4 +1029,4 @@ def rename_column(columns_names, logger=None):
             columns_names_new.insert(index, 'area')
         else:
             columns_names_new.insert(index, name)
-    return columns_names_new
+    return np.array(columns_names_new)

metcalcpy/util/utils.py

@@ -347,7 +347,7 @@ def column_data_by_name_value(input_data, columns, filters):
     try:
         # for each filter
         for key, value in filters.items():
-            # get an index og the column
+            # get an index of the column
             index_array = np.where(columns == key)[0]
             if index_array.size == 0:
                 return 0