.. only:: html
.. image:: ../logo/psyclone_v1.0.png
:width: 75%
:align: center
:alt: PSyclone
.. only:: html
PSyclone is a code generation system developed to support domain-specific
languages (DSLs) for finite element, finite volume and finite difference
codes. Notably, it is used in the
`LFRic Project <https://www.metoffice.gov.uk/research/modelling-systems/
lfric/>`_, and it also supports the
`GOcean <https://gtr.ukri.org/projects?ref=NE%2FL01209X%2F1>`_
(2D, finite difference) DSL. In addition it is being extended
to support the processing of existing finite difference codes such as the
`NEMO <https://www.nemo-ocean.eu/>`_ ocean model.
Find more information in the
`Developer's Guide <https://psyclone-dev.readthedocs.io/>`_
and the
`Reference Guide <https://psyclone-ref.readthedocs.io/>`_.
.. toctree::
:hidden:
:caption: Table of Contents
.. toctree::
:maxdepth: 2
:caption: Introduction
introduction
getting_going
psyclone_command
tutorial
examples
libraries
system_specific_setup
.. toctree::
:maxdepth: 2
:caption: PSyKAl
kernel_layer
algorithm_layer
psy_layer
built_ins
.. toctree::
:maxdepth: 2
:caption: Domain APIs
dynamo0p3
gocean1p0
nemo
.. toctree::
:maxdepth: 2
:caption: PSyclone Transformations
psyir
transformations
distributed_memory
.. toctree::
:maxdepth: 2
:caption: Utilities and Conventions
psyclone_kern
line_length
fortran_naming_conventions
api
psy_data
profiling
psyke
configuration
.. toctree::
:maxdepth: 2
:caption: Bibliography
zz_bibliography
.. only:: html
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`