AI-WQ-package 0.0.1__tar.gz

ai_wq_package-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ai_wq_package-0.0.1/PKG-INFO

@@ -0,0 +1,14 @@
+Metadata-Version: 2.3
+Name: AI_WQ_package
+Version: 0.0.1
+Summary: A python package to support forecast submission, evaluation and access to FTP site for DESTIN-E S2S AI prediction project
+Project-URL: Homepage, https://github.com/joshuatalib/AI_weather_quest
+Author-email: Joshua Talib <joshuatalib@ecmwf.int>
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# AI_weather_quest
+Python code to support and participate in ECMWF-hosted AI Weather Quest

ai_wq_package-0.0.1/README.md

@@ -0,0 +1,2 @@
+# AI_weather_quest
+Python code to support and participate in ECMWF-hosted AI Weather Quest

ai_wq_package-0.0.1/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "AI_WQ_package"
+version = "0.0.1"
+authors = [
+  { name="Joshua Talib", email="joshuatalib@ecmwf.int" },
+]
+description = "A python package to support forecast submission, evaluation and access to FTP site for DESTIN-E S2S AI prediction project"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/joshuatalib/AI_weather_quest"

ai_wq_package-0.0.1/src/AI_WQ_package/__init__.py

@@ -0,0 +1 @@
+# init file to enable import of a regular package.

ai_wq_package-0.0.1/src/AI_WQ_package/forecast_submission.py

@@ -0,0 +1,160 @@
+# python code that will accept quintile, lat, long data and submit forecast to FTP site
+import xarray as xr
+import numpy as np
+import ftplib
+
+def check_variable_in_list(variable_name, expected_values):
+    if variable_name not in expected_values:
+        raise ValueError(f"Expected one of {expected_values}, but got {variable_name}.")
+
+def convert_wk_lead_time_to_string(value):
+    # convert the wk_lead_time variable to a string for saving
+    if isinstance(value,(int,float)):
+        return str(int(value)) # save a string of the integer value
+    elif isinstance(value,(str)):
+        return value # if it already is a string, just return the string value
+    else:
+        raise ValueError(f"The value '{value}' is not a number nor str.")
+
+def check_and_flip_latitudes(ds, lat_name='latitude'):
+    """
+    Check if latitudes range from 90 to -90, and flip if necessary.
+
+    Parameters:
+        ds (xarray.Dataset): The dataset to check.
+        lat_name (str): Name of the latitude variable in the dataset.
+
+    Returns:
+        xarray.Dataset: The modified dataset with corrected latitude ordering. Latitude ordering should always be 90 to -90.
+    """
+    # Check if the latitude variable exists
+    if lat_name not in ds.coords:
+        raise ValueError(f"Latitude coordinate '{lat_name}' not found in the dataset.")
+
+    # Extract latitude values
+    latitudes = ds[lat_name].values
+
+    # Check if latitudes need to be flipped
+    if latitudes[0] < latitudes[-1]:  # If increasing order
+        print("Latitudes are in ascending order; flipping them to descend from 90 to -90.")
+        ds = ds.sortby(lat_name, ascending=False)
+    return ds
+
+def check_and_convert_longitudes(ds, lon_name='longitude'):
+    """
+    Check if longitudes range from 0 to 360 and convert if necessary.
+
+    Parameters:
+        ds (xarray.Dataset): The dataset to check.
+        lon_name (str): Name of the longitude variable in the dataset.
+
+    Returns:
+        xarray.Dataset: The modified dataset with longitudes converted to 0 to 360 range.
+    """
+    # Check if the longitude variable exists
+    if lon_name not in ds.coords:
+        raise ValueError(f"Longitude coordinate '{lon_name}' not found in the dataset.")
+
+    # Extract longitude values
+    longitudes = ds[lon_name].values
+
+    # Check if longitudes are in the -180 to 180 range
+    if np.any(longitudes < 0):
+        print("Longitudes are in the -180 to 180 range; converting to 0 to 360.")
+        longitudes = (longitudes + 360) % 360  # Convert to 0 to 360 range
+        ds = ds.assign_coords({lon_name: longitudes})  # Update the dataset's longitude coordinates
+    return ds
+
+def create_ftp_dir_if_does_not_exist(ftp,dir_name):
+    """
+    Create a directory on the FTP server only if it doesn't exist.
+    
+    Parameters:
+        ftp (ftplib.FTP): The FTP connection object.
+        dir_name (str): The name of the directory to create.
+    """
+    try:
+        # Try to list the directory
+        ftp.cwd(dir_name)
+        print(f"Directory '{dir_name}' already exists.")
+    except ftplib.error_perm as e:
+        # If directory doesn't exist (Permission error), create it
+        if "550" in str(e):  # "550" is the FTP error code for "directory not found"
+            ftp.mkd(dir_name)
+            print(f"Directory '{dir_name}' created.")
+        else:
+            # Raise if the error is something else (not directory not found)
+            raise
+
+def AI_WQ_forecast_submission(data,variable,fc_start_date,wk_lead_time,teamname,modelname):
+    ''' This function will take a dataset in quintile, lat, long format, save as appropriate netCDF format,
+    then copy to FTP site under correct forecast folder, i.e. 20241118. 
+
+    Parameters:
+        data: TBC
+        variable (str): Saved variable. Options include 'tas', 'mslp' and 'pr'.
+        fc_start_date (str): The forecast start date as a string in format '%Y%m%d', i.e. 20241118.
+        wk_lead_time (str or number): Three- or four-week forecast, i.e. '3' or 3.
+        teamname (str): The teamname that was submitted during registration.
+        modelname (str): Modelname for particular forecast. Teams are only allowed to submit three models each.
+
+    '''
+    ###############################################################################################################
+    # CHECKING DATA FORMAT AND INPUTTED VARIABLES
+
+    # Check all submitted variables are correct format.
+    check_variable_in_list(variable,['tas','mslp','pr'])
+    # do you need to check fc_start_date # maybe have a list of appropriate start dates? 
+    # check_variable_in_list(teamname,[]) # to be updated, check that teamname is in list of registered teamnames.
+
+    # if wk_lead_time is number, change to string.
+    wk_lead_time_str = convert_wk_lead_time_to_string(wk_lead_time)
+    check_variable_in_list(wk_lead_time_str,['3','4']) # then check wk_lead_time is either string of 3 or 4.
+
+    # after all checks have been performed regarding filename, save final finalname
+    final_filename = variable+'_'+fc_start_date+'_week'+wk_lead_time_str+'_'+teamname+'_'+modelname+'.nc'
+
+    ################################################################################################################
+    # OPEN NETCDF DATA AND INPUT INTO NEW netCDF xarray
+
+    # first perform some checks on xarray
+    # (1) latitudes should be 90.0 to -90.0
+    data = check_and_flip_latitudes(data)
+    # (2) longitudes should be 0 to 359.0
+    data = check_and_convert_longitudes(data)
+
+    # get data variable key and extract values
+    data_var_key = list(data.data_vars.keys())[0]
+    data_only = data[data_var_key].values # this should be shaped, quintile, latitude, longitude
+
+    # With the data, make a dataset array. Streamlining dataset creation so all submissions are the same.
+    ds = xr.Dataset(
+            data_vars=dict(variable=(['quintile','latitude','longitude'],data_only)),
+            coords=dict(quintile=np.arange(0.2,1.1,0.2), # outputs [0.2,0.4,0.6,0.8,1.0]
+                        latitude=np.arange(90.0,-91.0,-1.0),
+                        longitude=np.arange(0.0,360.0,1.0)),
+            attrs=dict(description=variable+' prediction from '+teamname+' using '+modelname+' at week '+wk_lead_time_str+' lead time'))
+
+    ds.to_netcdf(final_filename) # save netcdf file temporaily whether the script is being run
+    ################################################################################################################
+    # save new dataset as netCDF to FTP site
+    session = ftplib.FTP('ftp.ecmwf.int','ai_weather_quest','NegF8LfwK') # open FTP session
+    create_ftp_dir_if_does_not_exist(session,'forecast_submissions/'+fc_start_date) # save the forecast directory if it does not exist
+    file = open(final_filename,'rb') # read the forecast file
+    session.storbinary('STOR forecast_submissions/'+fc_start_date+'/'+final_filename,file) # transfer to FTP site
+    file.close() # close the file and quit the session
+    session.quit()
+
+    os.remove(final_filename)
+
+# code to test functions. give it saved netcdf file on PERM
+slp_wk3_predictions = xr.load_dataset('/perm/ecm0847/S2S_comp/'+'slp_20241111_wk3_ECext.nc')
+# submit forecasts to FTP site
+AI_WQ_forecast_submission(slp_wk3_predictions,'mslp','20241111','3','ECMWF','ext_range')
+
+
+
+
+
+
+