Mentions légales du service

Skip to content
Snippets Groups Projects
Commit 8357054c authored by Andrew Porter's avatar Andrew Porter
Browse files

#1574 update various README files and links to UG

parent 8ffa392c
No related branches found
No related tags found
No related merge requests found
# Introduction #
Welcome to PSyclone. PSyclone is a code generation system that generates
appropriate code for the PSyKAl code structure developed in the GungHo project.
Welcome to PSyclone. PSyclone is a code generation and transformation
system that generates appropriate code for the PSyKAl code structure
developed in the GungHo project. It is also capable of working with
existing Fortran code.
Please see [psyclone.pdf](psyclone.pdf) in this directory (or on
[ReadTheDocs](http://psyclone.readthedocs.io)) for
......@@ -58,15 +60,15 @@ add the latter location to your PATH.
Path | Description
------------------- | -----------
bin/ | top-level driver scripts for PSyclone and the Kernel stub generator
bin/ | Top-level driver scripts for PSyclone and the PSyclone kernel tool
changelog | Information on changes between releases
doc/ | Documentation source using sphinx
doc/ | Documentation source using Sphinx
examples/ | Simple examples
psyclone.pdf | Generated documentation
README.md | This file
README.gource | Information on how to generate a gource video from the repository
README.uml | Information on how to create UML class diagrams from the source using pyreverse
src/psyclone | The python source code
src/psyclone | The Python source code
src/psyclone/tests/ | Unit and functional tests using pytest
tutorial/notebooks | Tutorial using Jupyter notebooks
tutorial/practicals | Hands-on exercises using a local installation of PSyclone
......
# PSyclone Examples
**Author:** J. Henrichs, Bureau of Meteorology
**Modifications:** A. R. Porter, STFC Daresbury Laboratory
# Introduction
......@@ -24,9 +25,9 @@ This directory contains examples on how to use PSyIR to create
Fortran and C code as output.
## [stub_generation](./stub_generation)
This directory shows the usage of the stub-generation utility
included in PSyclone, which helps generating a Kernel's argument
list and its datatypes from the Kernel metadata.
This directory shows the usage of the stub-generation functionality
of the psyclone-kern utility. This helps with generating a Kernel's
argument list and associated datatypes from the Kernel metadata.
## transformations
This directory shows how to use the inline transformation.
......
......@@ -146,8 +146,7 @@ object. As a rule, object data are `private` as illustrated in the
### Argument list and declarations
Running the PSyclone
[kernel stub generator](https://psyclone.readthedocs.io/en/stable/stub_gen.html)
Running the PSyclone [kernel tool](https://psyclone.readthedocs.io/en/stable/psyclone_kern.html)
on `setval_field_w0_kernel_mod.f90` produces the argument list and
declarations for the `setval_field_w0_code`, enclosed in a module:
......@@ -206,9 +205,9 @@ ordering arguments is to put arguments that are written to first.
The full PSyclone LFRic API specification of the argument ordering for
the [general LFRic user-defined kernels](
https://psyclone.readthedocs.io/en/stable/dynamo0p3.html#rules-for-general-purpose-kernels)
is quite complex, hence making the [kernel-stub generator](
https://psyclone.readthedocs.io/en/stable/stub_gen.html) a very useful
development tool.
is quite complex, hence making the [PSyclone kernel tool](
https://psyclone.readthedocs.io/en/stable/psyclone_kern.html) very useful
for development.
LFRic kernels can update more than one field and/or operator arguments.
However, scalar arguments in user-defined LFRic kernels must be
......
......@@ -2,7 +2,7 @@
In this part of the [first tutorial](../README.md), we will use the
[stub-generation](
https://psyclone.readthedocs.io/en/stable/stub_gen.html) functionality
https://psyclone.readthedocs.io/en/stable/psyclone_kern.html) functionality
of the PSyclone kernel tool to create the argument list and declarations
for two kernels, one that assigns a value to a field on a continuous
`W0` function space and another on a discontinuous `W3` function space.
......
# Tutorial 1, Part 2: Update fields on a generic function space
In this part of the [first tutorial](../README.md), we will use the
[stub-generation](https://psyclone.readthedocs.io/en/stable/stub_gen.html)
[stub-generation](https://psyclone.readthedocs.io/en/stable/psyclone_kern.html)
functionality of the PSyclone kernel tool to
create the argument list and declarations for a generic kernel that
assigns a value to a field on any function space. For this we will use
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment