PSyclone User Guide

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.

PSyclone is currently used to support the LFRic mixed finite-element PSyKAl DSL for the UK MetOffice’s next generation modelling system and the GOcean finite-difference PSyKAl DSL for a prototype 2D ocean modelling system. It is also used to insert GPU offloading directives into existing directly-addressed MPI applications such as the NEMO ocean model.

More detailed implementation information is available in the Developer Guide and the Reference Guide.

Introduction

• Getting Going
  • Installation
  • Configuration
  • Running PSyclone
• The psyclone command
  • Basic Use
  • Transformation script
  • Fortran INCLUDE Files and Modules
  • Fortran line length
  • Backend Options
  • Automatic Profiling Instrumentation
  • Using PSyclone for PSyKAL DSLs
• Configuration
  • Options
• Tutorial and Examples
  • Tutorial
  • Examples
  • PSyIR Examples
  • GOcean Examples
  • LFRic Examples
  • NEMO Examples
• Libraries
  • Available libraries
  • Dependencies
  • Compilation

Code Transformation

• PSyIR: the PSyclone Intermediate Representation
  • PSyIR Nodes
  • Available language-level nodes
  • Text Representation
  • Tree Navigation
  • DataTypes
  • Symbols and Symbol Tables
  • Creating PSyIR
  • Comparing PSyIR nodes
  • Modifying the PSyIR
• Transformations
  • PSyclone User Scripts
  • Finding transformations
  • Validating and Applying transformations
  • Available transformations
  • Algorithm-layer
  • Kernels
  • OpenMP
  • OpenCL
  • OpenACC
  • SIR

PSyKAl DSLs

• Introduction to PSyKAl
  • Usage
  • Algorithm layer
  • Kernel layer
  • Built-ins
  • PSy layer
• LFRic API
  • Algorithm
  • Algorithm Argument Types
  • Mixed Precision
  • PSy-layer
  • Kernel
  • Built-ins
  • Boundary Conditions
  • Conventions
  • Configuration
  • Transformations
• GOcean1.0 API
  • Introduction
  • The GOcean Infrastructure Library - dl_esm_inf
  • Algorithm
  • Kernel
  • Built-ins
  • Conventions
  • Configuration
  • Transformations

Utilities and Conventions

• PSyclone Kernel Tools
  • The psyclone-kern Command
  • Kernel-stub Generator
  • Algorithm Generator
• Line length
  • Script
  • Interactive
  • Limitations
• Fortran Naming Conventions
• PSyData API
  • Read-Only Verification
  • Value Range Check
  • Integrating PSyData Libraries into the LFRic Build Environment
• Profiling
  • Interface to Third Party Profiling Tools
  • Required Modifications to the Program
  • Profiling Command-Line Options
  • Profiling in Scripts - ProfileTrans
  • Naming Profiling Regions
• PSy Kernel Extractor (PSyKE)
  • Introduction
  • Use
  • Extraction Libraries
  • Driver Summary Statistics

Bibliography

• Bibliography

Indices and tables

• Index

• Module Index

• Search Page