PSyclone 3.2.2rc2__tar.gz → 3.3.0__tar.gz

psyclone-3.3.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2017-2026, Science and Technology Facilities Council.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

psyclone-3.3.0/MANIFEST.in

@@ -0,0 +1,37 @@
+# -----------------------------------------------------------------------------
+# BSD 3-Clause License
+#
+# Copyright (c) 2017-2026, Science and Technology Facilities Council.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+include LICENSE
+include README*
+include CONTRIBUTING.md
+include src/psyclone/parse/lfric_builtins_mod.f90

psyclone-3.3.0/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: PSyclone
+Version: 3.3.0
+Summary: PSyclone - a source-to-source and DSL Fortran compiler for HPC applications
+Author: Rupert Ford
+Author-email: Andrew Porter <andrew.porter@stfc.ac.uk>, Sergi Siso <sergi.siso@stfc.ac.uk>, Aidan Chalk <aidan.chalk@stfc.ac.uk>, Joerg Henrichs <joerg.henrichs@bom.gov.au>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/stfc/psyclone
+Project-URL: Download, https://github.com/stfc/psyclone
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Fortran
+Classifier: Programming Language :: Python
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyparsing
+Requires-Dist: fparser==0.2.4
+Requires-Dist: configparser
+Requires-Dist: sympy<=1.13.3
+Requires-Dist: Jinja2
+Requires-Dist: termcolor
+Requires-Dist: graphviz
+Provides-Extra: doc
+Requires-Dist: sphinx<=8.3; extra == "doc"
+Requires-Dist: sphinxcontrib.bibtex; extra == "doc"
+Requires-Dist: sphinx_design; extra == "doc"
+Requires-Dist: pydata-sphinx-theme; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
+Requires-Dist: autoapi; extra == "doc"
+Provides-Extra: test
+Requires-Dist: flake8; extra == "test"
+Requires-Dist: pylint; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-xdist; extra == "test"
+Requires-Dist: tree-sitter; extra == "test"
+Requires-Dist: tree-sitter-fortran; extra == "test"
+Provides-Extra: treesitter
+Requires-Dist: tree-sitter; extra == "treesitter"
+Requires-Dist: tree-sitter-fortran; extra == "treesitter"
+Dynamic: license-file
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="doc/logo/psyclone_logo_dark_theme.png">
+  <source media="(prefers-color-scheme: light)" srcset="doc/logo/psyclone_logo_light_theme.png">
+  <img alt="PSyclone logo" width="460" src="doc/logo/psyclone_logo_light_theme.png">
+</picture>
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11190457.svg)](https://doi.org/10.5281/zenodo.11190457)
+![Build Status](https://github.com/stfc/PSyclone/workflows/PSyclone%20tests%20and%20examples/badge.svg)
+[![codecov](https://codecov.io/gh/stfc/PSyclone/branch/master/graph/badge.svg)](https://codecov.io/gh/stfc/PSyclone)
+
+PSyclone is a source-to-source Fortran compiler designed to programmatically
+optimise, parallelise and instrument HPC applications via user-provided
+transformation scripts. By encapsulating the performance-portability aspects
+(e.g. whether to parallelise with OpenMP or OpenACC), these scripts enable
+a separation of concerns between the scientific implementation and the
+optimisation choices. This allows each aspect to be explored and developed
+largely independently.
+Additionally, PSyclone supports the development of kernel-based Fortran-embedded
+DSLs following the PSyKAl model developed in the
+[GungHo project](https://www.metoffice.gov.uk/research/foundation/dynamics/next-generation).
+
+PSyclone is currently used to support the [LFRic mixed finite-element PSyKAl
+DSL](https://psyclone.readthedocs.io/en/latest/user_guide/lfric.html)
+for the [UK MetOffice's next generation modelling
+system](https://www.metoffice.gov.uk/research/approach/modelling-systems/lfric) and
+the [GOcean finite-difference PSyKAl
+DSL](https://psyclone.readthedocs.io/en/latest/user_guide/gocean1p0.html) for a [prototype
+2D ocean modelling system](https://gtr.ukri.org/projects?ref=NE%2FL01209X%2F1).
+It is also used to [insert GPU offloading
+directives](https://psyclone.readthedocs.io/en/latest/tutorials_and_examples/nemo_examples.html) into existing
+directly-addressed MPI applications such as the
+[NEMO ocean model](https://www.nemo-ocean.eu/).
+
+For more detailed information see the [PSyclone Documentation](http://psyclone.readthedocs.io/en/latest).
+
+# Installation #
+
+You can install the latest release of psyclone from PyPI by using:
+
+    $ pip install psyclone
+
+or, if you want an isolated installation in a [python virtual
+environment](https://docs.python.org/3/library/venv.html):
+
+    $ python -m venv <virtual_env_name>
+    $ source <virtual_env_name>/bin/activate
+    $ pip install psyclone
+
+Alternatively, you can install the latest upstream version of psyclone by
+cloning this repository and using:
+
+    $ pip install .
+
+or in developer (editable) mode using
+
+    $ pip install -e .
+
+PSyclone is also available in the
+[Conda](https://anaconda.org/conda-forge/psyclone) and
+[Spack](https://packages.spack.io/package.html?name=py-psyclone) package
+managers.
+
+For more information about the installation process see the
+[Getting Going](https://psyclone.readthedocs.io/en/latest/user_guide/getting_going.html).
+section of the User Guide.
+
+<!---  TODO #2627
+# Try it on Binder #
+
+Some of the examples are available as Jupyter notebooks. These may
+be launched using Binder from the links below. (Note that the first time
+this is done, Binder has to construct a Container and install the necessary
+software. This can take several minutes. You can track its progress
+by clicking the 'show' link next to the 'Build logs' heading.)
+
+ * [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/stfc/psyclone/master?filepath=tutorial%2Fnotebooks%2Fintroduction.ipynb) The **PSyclone Tutorial**. Note that we currently recommend following the more up-to-date README files under the `tutorials/practicals` directory.
+
+ * [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/stfc/psyclone/master?filepath=examples%2Fgocean%2Feg1%2Fopenmp.ipynb) Uses PSyclone's GOcean API to process example code that conforms to the PSyKAl separation of concerns. Transformations are applied in order to fuse various loops before parallelising the result with OpenMP.
+ 
+ * [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/stfc/psyclone/master?filepath=examples%2Fgocean%2Feg1%2Fdag.ipynb) demonstrates the generation of a DAG for the PSy layer of the previous example.
+--->
+
+# Structure #
+
+Path                | Description
+------------------- | -----------
+bin/                | Top-level driver scripts for PSyclone and the PSyclone kernel tool
+changelog      	    | Information on changes between releases
+doc/           	    | Documentation source using Sphinx
+examples/      	    | Simple examples
+README.md      	    | This file
+src/psyclone   	    | The Python source code
+src/psyclone/tests/ | Unit and functional tests using pytest
+tutorial/practicals | Hands-on exercises using a local installation of PSyclone

psyclone-3.3.0/README.md

@@ -0,0 +1,94 @@
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="doc/logo/psyclone_logo_dark_theme.png">
+  <source media="(prefers-color-scheme: light)" srcset="doc/logo/psyclone_logo_light_theme.png">
+  <img alt="PSyclone logo" width="460" src="doc/logo/psyclone_logo_light_theme.png">
+</picture>
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11190457.svg)](https://doi.org/10.5281/zenodo.11190457)
+![Build Status](https://github.com/stfc/PSyclone/workflows/PSyclone%20tests%20and%20examples/badge.svg)
+[![codecov](https://codecov.io/gh/stfc/PSyclone/branch/master/graph/badge.svg)](https://codecov.io/gh/stfc/PSyclone)
+
+PSyclone is a source-to-source Fortran compiler designed to programmatically
+optimise, parallelise and instrument HPC applications via user-provided
+transformation scripts. By encapsulating the performance-portability aspects
+(e.g. whether to parallelise with OpenMP or OpenACC), these scripts enable
+a separation of concerns between the scientific implementation and the
+optimisation choices. This allows each aspect to be explored and developed
+largely independently.
+Additionally, PSyclone supports the development of kernel-based Fortran-embedded
+DSLs following the PSyKAl model developed in the
+[GungHo project](https://www.metoffice.gov.uk/research/foundation/dynamics/next-generation).
+
+PSyclone is currently used to support the [LFRic mixed finite-element PSyKAl
+DSL](https://psyclone.readthedocs.io/en/latest/user_guide/lfric.html)
+for the [UK MetOffice's next generation modelling
+system](https://www.metoffice.gov.uk/research/approach/modelling-systems/lfric) and
+the [GOcean finite-difference PSyKAl
+DSL](https://psyclone.readthedocs.io/en/latest/user_guide/gocean1p0.html) for a [prototype
+2D ocean modelling system](https://gtr.ukri.org/projects?ref=NE%2FL01209X%2F1).
+It is also used to [insert GPU offloading
+directives](https://psyclone.readthedocs.io/en/latest/tutorials_and_examples/nemo_examples.html) into existing
+directly-addressed MPI applications such as the
+[NEMO ocean model](https://www.nemo-ocean.eu/).
+
+For more detailed information see the [PSyclone Documentation](http://psyclone.readthedocs.io/en/latest).
+
+# Installation #
+
+You can install the latest release of psyclone from PyPI by using:
+
+    $ pip install psyclone
+
+or, if you want an isolated installation in a [python virtual
+environment](https://docs.python.org/3/library/venv.html):
+
+    $ python -m venv <virtual_env_name>
+    $ source <virtual_env_name>/bin/activate
+    $ pip install psyclone
+
+Alternatively, you can install the latest upstream version of psyclone by
+cloning this repository and using:
+
+    $ pip install .
+
+or in developer (editable) mode using
+
+    $ pip install -e .
+
+PSyclone is also available in the
+[Conda](https://anaconda.org/conda-forge/psyclone) and
+[Spack](https://packages.spack.io/package.html?name=py-psyclone) package
+managers.
+
+For more information about the installation process see the
+[Getting Going](https://psyclone.readthedocs.io/en/latest/user_guide/getting_going.html).
+section of the User Guide.
+
+<!---  TODO #2627
+# Try it on Binder #
+
+Some of the examples are available as Jupyter notebooks. These may
+be launched using Binder from the links below. (Note that the first time
+this is done, Binder has to construct a Container and install the necessary
+software. This can take several minutes. You can track its progress
+by clicking the 'show' link next to the 'Build logs' heading.)
+
+ * [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/stfc/psyclone/master?filepath=tutorial%2Fnotebooks%2Fintroduction.ipynb) The **PSyclone Tutorial**. Note that we currently recommend following the more up-to-date README files under the `tutorials/practicals` directory.
+
+ * [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/stfc/psyclone/master?filepath=examples%2Fgocean%2Feg1%2Fopenmp.ipynb) Uses PSyclone's GOcean API to process example code that conforms to the PSyKAl separation of concerns. Transformations are applied in order to fuse various loops before parallelising the result with OpenMP.
+ 
+ * [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/stfc/psyclone/master?filepath=examples%2Fgocean%2Feg1%2Fdag.ipynb) demonstrates the generation of a DAG for the PSy layer of the previous example.
+--->
+
+# Structure #
+
+Path                | Description
+------------------- | -----------
+bin/                | Top-level driver scripts for PSyclone and the PSyclone kernel tool
+changelog      	    | Information on changes between releases
+doc/           	    | Documentation source using Sphinx
+examples/      	    | Simple examples
+README.md      	    | This file
+src/psyclone   	    | The Python source code
+src/psyclone/tests/ | Unit and functional tests using pytest
+tutorial/practicals | Hands-on exercises using a local installation of PSyclone

psyclone-3.3.0/bin/psyad

@@ -0,0 +1,46 @@
+#!/usr/bin/env python
+# -----------------------------------------------------------------------------
+# BSD 3-Clause License
+#
+# Copyright (c) 2021-2026, Science and Technology Facilities Council
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+# Authors R. W. Ford and A. R. Porter, STFC Daresbury Lab
+
+'''Top-level executable driver script wrapper for PSyAD : the PSyclone
+Adjoint support. Transforms an LFRic tangent linear kernel to its
+adjoint.
+
+'''
+import sys
+from psyclone.psyad import main
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

psyclone-3.3.0/bin/psyclone

@@ -0,0 +1,42 @@
+#!/usr/bin/env python
+# -----------------------------------------------------------------------------
+# BSD 3-Clause License
+#
+# Copyright (c) 2017-2026, Science and Technology Facilities Council
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+
+''' Top-level driver script for PSyclone. '''
+
+import sys
+from psyclone.generator import main
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

psyclone-3.3.0/bin/psyclone-kern

@@ -0,0 +1,46 @@
+#!/usr/bin/env python
+# -----------------------------------------------------------------------------
+# BSD 3-Clause License
+#
+# Copyright (c) 2017-2026, Science and Technology Facilities Council
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+# Authors: R. W. Ford and A. R. Porter, STFC Daresbury Lab
+
+'''A Python driver script for the PSyclone kernel utilities tool.
+'''
+
+import sys
+from psyclone.kernel_tools import run
+
+
+if __name__ == "__main__":
+
+    run(sys.argv[1:])

psyclone-3.3.0/bin/psyclonefc

@@ -0,0 +1,45 @@
+#!/usr/bin/env python
+# -----------------------------------------------------------------------------
+# BSD 3-Clause License
+#
+# Copyright (c) 2025-2026, Science and Technology Facilities Council
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+
+'''
+Entry point for the psyclonefc command (PSyclone's compiler wrapper script).
+'''
+
+import sys
+from psyclone.psyclonefc_cli import compiler_wrapper
+
+
+if __name__ == "__main__":
+    compiler_wrapper(sys.argv[1:])

psyclone-3.3.0/config/psyclone.cfg

@@ -0,0 +1,155 @@
+# -----------------------------------------------------------------------------
+# BSD 3-Clause License
+#
+# Copyright (c) 2017-2026, Science and Technology Facilities Council
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+# Author: A. R. Porter, STFC Daresbury Laboratory
+# Modified by: R. W. Ford, STFC Daresbury Laboratory
+#              S. Siso, STFC Daresbury Laboratory
+#              J. Henrichs, Bureau of Meteorology,
+#              I. Kavcic and O. Brunt, Met Office
+
+# This is the PSyclone configuration file.
+
+# Settings common to all APIs
+[DEFAULT]
+DISTRIBUTED_MEMORY = true
+REPRODUCIBLE_REDUCTIONS = false
+# Amount to pad the local summation array when REPRODUCIBLE_REDUCTIONS is true
+REPROD_PAD_SIZE = 8
+PSYIR_ROOT_NAME = psyir_tmp
+VALID_PSY_DATA_PREFIXES = profile, extract, read_only_verify, value_range_check
+
+# Specify number of OpenCL devices per node. When combining OpenCL with MPI,
+# the mpirun/mpiexec ranks_per_node parameter must match this number.
+OCL_DEVICES_PER_NODE = 1
+
+# Symbols imported from the following modules will be ignored when parsing
+# and will not produce a warning message if they cannot be found.
+IGNORE_MODULES = netcdf, mpi
+
+# The Fortran standard to use when parsing files. This value is passed
+# to fparser. Valid values are f2003 and f2008
+FORTRAN_STANDARD = f2008
+
+# Settings specific to the LFRic API
+# ==================================
+[lfric]
+# Specify whether we compute annexed dofs when a kernel is written so
+# that it iterates over dofs. This is currently only the case for
+# builtins. If annexed dofs are computed then in certain cases we
+# remove the need for a halo exchange call.
+COMPUTE_ANNEXED_DOFS = false
+
+# Specify supported Fortran datatypes
+supported_fortran_datatypes = real, integer, logical
+
+# Specify default kind (precision) for the supported LFRic data types
+default_kind = real: r_def, integer: i_def, logical: l_def
+
+# Specify number of bytes for the supported LFRic data types.
+# The values for 'r_tran', 'r_solver', 'r_def', 'r_bl' and 'r_phys' are
+# set according to CPP ifdefs. The values given below are the defaults.
+# 'l_def' is included in this dict so that it contains a complete
+# record of the various precision symbols used in LFRic.
+precision_map = i_def: 4,
+                l_def: 1,
+                r_def: 8,
+                r_double: 8,
+                r_ncdf: 8,
+                r_quad: 16,
+                r_second: 8,
+                r_single: 4,
+                r_solver: 4,
+                r_tran: 8,
+                r_bl: 8,
+                r_um: 8
+
+# Specify whether we generate code to perform runtime correctness checks.
+# Allowed values:
+# none:  no run time checks are added
+# warn:  run time checks are added, violations will create a warning
+# error: run time checks are added, violations will create an error and abort
+RUN_TIME_CHECKS = none
+
+# Number of ANY_SPACE and ANY_DISCONTINUOUS_SPACE function spaces
+NUM_ANY_SPACE = 10
+NUM_ANY_DISCONTINUOUS_SPACE = 10
+
+# Settings specific to the Gocean API
+# ===================================
+[gocean]
+# The detail for grid properties. There are four entries:
+# 1) The name used in a kernel declaration.
+# 2) The string required to dereference the property from the field.
+#    A {0} is replaced with the name of the field variable
+# 3) The type of the property: must be 'scalar' or 'array'.
+# 4) The intrinsic type of the property: must be 'integer' or 'real'.
+# The following values are used by PSyclone, and are therefore required:
+# go_grid_xstop, go_grid_ystop, 
+# go_grid_{internal,whole}_{inner,outer}_{start,stop}
+# Details about the grid properties and their usage can be found in the
+# PSyclone documentation at:
+# https://psyclone.readthedocs.io/en/stable/gocean1p0.html#argument-metadata-meta-args
+grid-properties = go_grid_xstop: {0}%%grid%%subdomain%%internal%%xstop: scalar: integer,
+                  go_grid_ystop: {0}%%grid%%subdomain%%internal%%ystop: scalar: integer,
+                  go_grid_data: {0}%%data: array: real,
+                  go_grid_internal_inner_stop: {0}%%internal%%xstop: scalar: integer,
+                  go_grid_internal_outer_stop: {0}%%internal%%ystop: scalar: integer,
+                  go_grid_whole_inner_stop: {0}%%whole%%xstop: scalar: integer,
+                  go_grid_whole_outer_stop: {0}%%whole%%ystop: scalar: integer,
+                  go_grid_internal_inner_start: {0}%%internal%%xstart: scalar: integer,
+                  go_grid_internal_outer_start: {0}%%internal%%ystart: scalar: integer,
+                  go_grid_whole_inner_start: {0}%%whole%%xstart: scalar: integer,
+                  go_grid_whole_outer_start: {0}%%whole%%ystart: scalar: integer,
+                  go_grid_area_t: {0}%%grid%%area_t: array: real,
+                  go_grid_area_u: {0}%%grid%%area_u: array: real,
+                  go_grid_area_v: {0}%%grid%%area_v: array: real,
+                  go_grid_mask_t: {0}%%grid%%tmask: array: integer,
+                  go_grid_dx_t: {0}%%grid%%dx_t: array: real,
+                  go_grid_dx_u: {0}%%grid%%dx_u: array: real,
+                  go_grid_dx_v: {0}%%grid%%dx_v: array: real,
+                  go_grid_dy_t: {0}%%grid%%dy_t: array: real,
+                  go_grid_dy_u: {0}%%grid%%dy_u: array: real,
+                  go_grid_dy_v: {0}%%grid%%dy_v: array: real,
+                  go_grid_lat_u: {0}%%grid%%gphiu: array: real,
+                  go_grid_lat_v: {0}%%grid%%gphiv: array: real,
+                  go_grid_dx_const: {0}%%grid%%dx: scalar: real,
+                  go_grid_dy_const: {0}%%grid%%dy: scalar: real,
+                  go_grid_nx: {0}%%grid%%nx: scalar: integer,
+                  go_grid_ny: {0}%%grid%%ny: scalar: integer,
+                  go_grid_x_min_index: {0}%%grid%%subdomain%%internal%%xstart: scalar: integer,
+                  go_grid_x_max_index: {0}%%grid%%subdomain%%internal%%xstop: scalar: integer,
+                  go_grid_y_min_index: {0}%%grid%%subdomain%%internal%%ystart: scalar: integer,
+                  go_grid_y_max_index: {0}%%grid%%subdomain%%internal%%ystop: scalar: integer
+
+# Specify whether we generate additional debug code
+DEBUG_MODE = false