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.
For more detailed information see the PSyclone Documentation.
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:
$ 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 and Spack package managers.
For more information about the installation process see the Getting Going. section of the User Guide.
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 |
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file psyclone-3.3.1.tar.gz.
File metadata
- Download URL: psyclone-3.3.1.tar.gz
- Upload date:
- Size: 1.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9d256cc4ee1494286b1ed8b4b8447b576748008ea5e236159717db1ddc3bd09a
|
|
| MD5 |
215145164bd43f801820bcd0167d2ed0
|
|
| BLAKE2b-256 |
01d59cece37db9b2e5deb31650a25fa1a8c5a9a6e3834675f9526c9adb13eff0
|
Provenance
The following attestation bundles were made for psyclone-3.3.1.tar.gz:
Publisher:
python_publish.yml on stfc/PSyclone
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
psyclone-3.3.1.tar.gz -
Subject digest:
9d256cc4ee1494286b1ed8b4b8447b576748008ea5e236159717db1ddc3bd09a - Sigstore transparency entry: 2098684668
- Sigstore integration time:
-
Permalink:
stfc/PSyclone@bee88804a8613f6a1176243f99880182a63dcd1f -
Branch / Tag:
refs/tags/v3.3.1 - Owner: https://github.com/stfc
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python_publish.yml@bee88804a8613f6a1176243f99880182a63dcd1f -
Trigger Event:
release
-
Statement type:
File details
Details for the file psyclone-3.3.1-py3-none-any.whl.
File metadata
- Download URL: psyclone-3.3.1-py3-none-any.whl
- Upload date:
- Size: 2.5 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ed2c5d12a5aa07d738cfdc32b817faf415f5144321363dcc0c2eecf6d041b5db
|
|
| MD5 |
2d37cbd8f609b0b1459209525988c6da
|
|
| BLAKE2b-256 |
b166134b28e90b9540bfd54c37277243b457e93864415d8f3aa48d427f936a24
|
Provenance
The following attestation bundles were made for psyclone-3.3.1-py3-none-any.whl:
Publisher:
python_publish.yml on stfc/PSyclone
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
psyclone-3.3.1-py3-none-any.whl -
Subject digest:
ed2c5d12a5aa07d738cfdc32b817faf415f5144321363dcc0c2eecf6d041b5db - Sigstore transparency entry: 2098684979
- Sigstore integration time:
-
Permalink:
stfc/PSyclone@bee88804a8613f6a1176243f99880182a63dcd1f -
Branch / Tag:
refs/tags/v3.3.1 - Owner: https://github.com/stfc
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python_publish.yml@bee88804a8613f6a1176243f99880182a63dcd1f -
Trigger Event:
release
-
Statement type:
