Merge pull request #2501 from stfc/2447_release_2.5.0

(Closes #2447) Create release 2.5.0

Author: TeranIvy

LICENSE

@@ -1,10 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2017, Science and Technology Facilities Council
-(c) The copyright relating to this work is owned jointly by the Crown,
-Met Office and NERC 2016.
-However, it has been created with the help of the GungHo Consortium,
-whose members are identified at https://puma.nerc.ac.uk/trac/GungHo/wiki
+Copyright (c) 2017-2024, Science and Technology Facilities Council.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

changelog

@@ -162,6 +162,8 @@
 
 	59) PR #2490 towards #2447. Update PSyclone to use fparser 0.1.4 release.
 
+	60) PR #2501 for #2447. Create PSyclone release 2.5.0.
+
 release 2.4.0 29th of September 2023
 
 	1) PR #1758 for #1741. Splits the PSyData read functionality into a

doc/developer_guide/conf.py

@@ -88,26 +88,30 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u"PSyclone Developer Guide"
-copyright = u'2017-2023, STFC Daresbury Laboratory'
+project = "PSyclone Developer Guide"
+project_copyright = '2017-2024, STFC Daresbury Laboratory'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # We use the version module in src/psyclone. However, rather than importing
 # it (which would require that PSyclone be installed first), we read it
-# using execfile().
+# using exec().
 # 'version' is the short X.Y version and 'release' is the full version,
 # including any alpha/beta/rc tags.
 # We are in the doc/developer_guide directory but need to read version.py from
 # src/psyclone
 BASE_PATH = os.path.dirname(os.path.abspath(__file__))
 BASE_PATH = os.path.dirname(os.path.dirname(BASE_PATH))
-with open(os.path.join(BASE_PATH, "src", "psyclone", "version.py")) as f:
+with open(os.path.join(BASE_PATH, "src", "psyclone", "version.py"),
+          encoding="utf-8") as f:
+    # pylint: disable-next=exec-used
     exec(f.read())
+# pylint: disable=undefined-variable
 version = __SHORT_VERSION__
 release = __VERSION__
+# pylint: enable=undefined-variable
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -246,8 +250,8 @@
 # (source start file, target name, title, author,
 #  documentclass [howto/manual]).
 latex_documents = [
-    ('index', 'psyclone-dev.tex', u"PSyclone Developer Guide",
-     u'Oakley Brunt, Rupert Ford, Joerg Henrichs, Iva Kavcic, \\\\'
+    ('index', 'psyclone-dev.tex', "PSyclone Developer Guide",
+     'Oakley Brunt, Rupert Ford, Joerg Henrichs, Iva Kavcic, \\\\'
      'Andrew Porter, Sergi Siso and Lottie Turner', 'manual'),
 ]
 
@@ -277,8 +281,8 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'psyclone-dev', u"PSyclone Developer Guide",
-     [u'Oakley Brunt, Rupert Ford, Joerg Henrichs, Iva Kavcic, Andrew Porter, '
+    ('index', 'psyclone-dev', "PSyclone Developer Guide",
+     ['Oakley Brunt, Rupert Ford, Joerg Henrichs, Iva Kavcic, Andrew Porter, '
       'Sergi Siso and Lottie Turner'], 1)
 ]
 
@@ -292,8 +296,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'psyclone-dev', u"PSyclone Developer Guide",
-     [u'Oakley Brunt, Rupert Ford, Joerg Henrichs, Iva Kavcic, Andrew Porter, '
+    ('index', 'psyclone-dev', "PSyclone Developer Guide",
+     ['Oakley Brunt, Rupert Ford, Joerg Henrichs, Iva Kavcic, Andrew Porter, '
       'Sergi Siso and Lottie Turner'], 'psyclone',
      'A domain-specific compiler for Finite-Element/Volume/Difference models.',
      'Miscellaneous'),
@@ -312,12 +316,12 @@
 # -- Options for Epub output -------------------------------------------------
 
 # Bibliographic Dublin Core info.
-epub_title = u"PSyclone Developer Guide"
-epub_author = u'Oakley Brunt, Rupert Ford, Joerg Henrichs, Iva Kavcic, ' \
+epub_title = "PSyclone Developer Guide"
+epub_author = 'Oakley Brunt, Rupert Ford, Joerg Henrichs, Iva Kavcic, ' \
     'Andrew Porter, Sergi Siso and Lottie Turner'
-epub_publisher = u'Oakley Brunt, Rupert Ford, Joerg Henrichs, Iva Kavcic, ' \
+epub_publisher = 'Oakley Brunt, Rupert Ford, Joerg Henrichs, Iva Kavcic, ' \
     'Andrew Porter, Sergi Siso and Lottie Turner'
-epub_copyright = copyright
+epub_copyright = project_copyright
 
 # The language of the text. It defaults to the language option
 # or en if the language is not set.

doc/reference_guide/doxygen.config

@@ -38,7 +38,7 @@ PROJECT_NAME           = "Reference Guide"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.4.0
+PROJECT_NUMBER         = 2.5.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

doc/reference_guide/source/conf.py

@@ -1,6 +1,10 @@
 # -*- coding: utf-8 -*-
 #
-# Configuration file for the Sphinx documentation builder.
+'''
+Configuration file for the Sphinx documentation builder.
+
+'''
+
 #
 # This file does only contain a selection of the most common options. For a
 # full list see the documentation:
@@ -13,23 +17,35 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import subprocess
-# import os
+import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
 
 # -- Project information -----------------------------------------------------
 
 project = 'Reference Guide'
-copyright = ('2019-2023, R. W. Ford, J. Henrichs, I. Kavcic, A. R. Porter, '
-             ' S. Siso')
+project_copyright = ('2019-2024, R. W. Ford, J. Henrichs, I. Kavcic, '
+                     'A. R. Porter, S. Siso')
 author = 'R. W. Ford, J. Henrichs, I. Kavcic, A. R. Porter, S. Siso'
 
-# The short X.Y version
-version = ''
-# The full version, including alpha/beta/rc tags
-release = '2.4.0'
-
+# We use the version module in src/psyclone. However, rather than importing
+# it (which would require that PSyclone be installed first), we read it
+# using execfile().
+# We are in the doc/reference_guide/source directory but need to read
+# version.py from src/psyclone
+BASE_PATH = os.path.dirname(os.path.abspath(__file__))
+BASE_PATH = os.path.dirname(os.path.dirname(os.path.dirname(BASE_PATH)))
+with open(os.path.join(BASE_PATH, "src", "psyclone", "version.py"),
+          encoding="utf-8") as f:
+    # pylint: disable-next=exec-used
+    exec(f.read())
+# pylint: disable=undefined-variable
+# The short X.Y version.
+version = __SHORT_VERSION__
+# The full version, including alpha/beta/rc tags.
+release = __VERSION__
+# pylint: enable=undefined-variable
 
 # -- General configuration ---------------------------------------------------
 

doc/user_guide/conf.py

@@ -82,7 +82,7 @@
 
 # General information about the project.
 project = 'PSyclone'
-copyright = '2017-2023, STFC Daresbury Laboratory'
+project_copyright = '2017-2024, STFC Daresbury Laboratory'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -99,9 +99,12 @@
 BASE_PATH = os.path.dirname(os.path.dirname(BASE_PATH))
 with open(os.path.join(BASE_PATH, "src", "psyclone", "version.py"),
           encoding="utf-8") as f:
+    # pylint: disable-next=exec-used
     exec(f.read())
+# pylint: disable=undefined-variable
 version = __SHORT_VERSION__
 release = __VERSION__
+# pylint: enable=undefined-variable
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -285,8 +288,8 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'psyclone', u'PSyclone Documentation',
-     [u'Rupert Ford, Joerg Henrichs, Iva Kavcic, Andrew Porter, Sergi '
+    ('index', 'psyclone', 'PSyclone Documentation',
+     ['Rupert Ford, Joerg Henrichs, Iva Kavcic, Andrew Porter, Sergi '
       'Siso and Joseph Wallwork'], 1)
 ]
 
@@ -300,8 +303,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'psyclone', u'psyclone Documentation',
-     u'Rupert Ford, Joerg Henrichs, Iva Kavcic, Andrew Porter, Sergi Siso and'
+    ('index', 'psyclone', 'psyclone Documentation',
+     'Rupert Ford, Joerg Henrichs, Iva Kavcic, Andrew Porter, Sergi Siso and'
      'Joseph Wallwork',
      'psyclone',
      'A domain-specific compiler for Finite-Element/Volume/Difference models.',
@@ -321,10 +324,10 @@
 # -- Options for Epub output -------------------------------------------------
 
 # Bibliographic Dublin Core info.
-epub_title = u'PSyclone'
-epub_author = u'Rupert Ford, Joerg Henrichs, Iva Kavcic, Andrew Porter, ' \
+epub_title = 'PSyclone'
+epub_author = 'Rupert Ford, Joerg Henrichs, Iva Kavcic, Andrew Porter, ' \
     'Sergi Siso and Joseph Wallwork'
-epub_publisher = u'Rupert Ford, Joerg Henrichs, Iva Kavcic, Andrew Porter, ' \
+epub_publisher = 'Rupert Ford, Joerg Henrichs, Iva Kavcic, Andrew Porter, ' \
     'Sergi Siso and Joseph Wallwork'
 epub_copyright = copyright
 
@@ -373,10 +376,10 @@
 
 # MyBinder fails on a very regular basis so we skip those links.
 linkcheck_ignore = [r'^https://mybinder.org/v2/gh/stfc/psyclone',
-# Shpinx has problems wiht Github anchors, so we skip the links to anchors to
-# the main README
+                    # Sphinx has problems with Github anchors, so we skip
+                    # the links to anchors to the main README.
                     r'^https://github.com/stfc/PSyclone#',
-# Requires authentication
+                    # Requires authentication.
                     r'code.metoffice.gov.uk/trac/lfric/attachment/wiki/'
                     r'LFRicDocumentationPapers/lfric_documentation.pdf']
 

examples/gocean/eg3/.gitignore

@@ -1 +1 @@
-opencl_kernels_0.cl
+opencl_kernels_?.cl

psyclone.pdf

@@ -51,9 +51,10 @@
                                   "psyclone.tests.*"])
 
 NAME = 'PSyclone'
-AUTHOR = ("Rupert Ford <rupert.ford@stfc.ac.uk>, "
-          "Andrew Porter <andrew.porter@stfc.ac.uk>")
-AUTHOR_EMAIL = 'rupert.ford@stfc.ac.uk'
+AUTHOR = ('Rupert Ford <rupert.ford@stfc.ac.uk>, '
+          'Andrew Porter <andrew.porter@stfc.ac.uk>, '
+          'Sergi Siso <sergi.siso@stfc.ac.uk>')
+AUTHOR_EMAIL = 'andrew.porter@stfc.ac.uk'
 URL = 'https://github.com/stfc/psyclone'
 DOWNLOAD_URL = 'https://github.com/stfc/psyclone'
 DESCRIPTION = ('PSyclone - a compiler for Finite Element/Volume/Difference'
@@ -160,7 +161,7 @@ def get_files(directory, install_path, valid_suffixes):
         classifiers=CLASSIFIERS,
         packages=PACKAGES,
         package_dir={"": "src"},
-        install_requires=['pyparsing', 'fparser>=0.1.3', 'configparser',
+        install_requires=['pyparsing', 'fparser>=0.1.4', 'configparser',
                           'jsonschema', 'sympy'],
         extras_require={
             'dag': ["graphviz"],

setup.py

@@ -35,10 +35,11 @@
 # Modified by R. W. Ford and N. Nobre, STFC Daresbury Lab
 
 ''' Single location for the current version number of PSyclone. This is
-    used in setup.py and doc/conf.py '''
+    used in setup.py and
+    doc/{user_guide,developer_guide,reference_guide/source}/conf.py '''
 
 __MAJOR__ = 2
-__MINOR__ = 4
+__MINOR__ = 5
 __MICRO__ = 0
 
 __SHORT_VERSION__ = f"{__MAJOR__:d}.{__MINOR__:d}"