diff --git a/loki/__init__.py b/loki/__init__.py index a9f7ad1ea..e5f48fb47 100644 --- a/loki/__init__.py +++ b/loki/__init__.py @@ -5,6 +5,10 @@ # granted to it by virtue of its status as an intergovernmental organisation # nor does it submit to any jurisdiction. +""" +The Loki source-to-source translation package for Fortran codes. +""" + from importlib.metadata import version, PackageNotFoundError # Import the global configuration map diff --git a/loki/analyse/__init__.py b/loki/analyse/__init__.py index 40f00834d..85685fede 100644 --- a/loki/analyse/__init__.py +++ b/loki/analyse/__init__.py @@ -4,5 +4,8 @@ # In applying this licence, ECMWF does not waive the privileges and immunities # granted to it by virtue of its status as an intergovernmental organisation # nor does it submit to any jurisdiction. +""" +Advanced analysis utilities, such as dataflow analysis functionalities. +""" from loki.analyse.analyse_dataflow import * # noqa diff --git a/loki/backend/__init__.py b/loki/backend/__init__.py index acacaa1d5..f44273879 100644 --- a/loki/backend/__init__.py +++ b/loki/backend/__init__.py @@ -4,6 +4,9 @@ # In applying this licence, ECMWF does not waive the privileges and immunities # granted to it by virtue of its status as an intergovernmental organisation # nor does it submit to any jurisdiction. +""" +Backend classes that convert Loki IR into output code in various languages. +""" from loki.backend.fgen import * # noqa from loki.backend.cgen import * # noqa diff --git a/loki/batch/__init__.py b/loki/batch/__init__.py index 56f454cc6..f21eca3b3 100644 --- a/loki/batch/__init__.py +++ b/loki/batch/__init__.py @@ -4,6 +4,15 @@ # In applying this licence, ECMWF does not waive the privileges and immunities # granted to it by virtue of its status as an intergovernmental organisation # nor does it submit to any jurisdiction. +""" +Batch processing abstraction for processing large source trees with Loki. + +This sub-package provides the :any:`Scheduler` class that allows Loki +transformations to be applied over large source trees. For this it +provides the basic :any:`Transformation` and :and:`Pipeline` classes +that provide the core interfaces for batch processing, as well as the +configuration utilities for large call tree traversals. +""" from loki.batch.configure import * # noqa from loki.batch.item import * # noqa diff --git a/loki/build/__init__.py b/loki/build/__init__.py index 5d0ebd49f..202ec1999 100644 --- a/loki/build/__init__.py +++ b/loki/build/__init__.py @@ -4,6 +4,13 @@ # In applying this licence, ECMWF does not waive the privileges and immunities # granted to it by virtue of its status as an intergovernmental organisation # nor does it submit to any jurisdiction. +""" +Just-in-Time compilation utilities used in the Loki test base. + +These allow compilation and wrapping of generated Fortran source code +using `f90wrap ` for +execution from Python tests. +""" from loki.logging import * # noqa diff --git a/loki/expression/__init__.py b/loki/expression/__init__.py index 495515f2c..04670ebdd 100644 --- a/loki/expression/__init__.py +++ b/loki/expression/__init__.py @@ -4,6 +4,10 @@ # In applying this licence, ECMWF does not waive the privileges and immunities # granted to it by virtue of its status as an intergovernmental organisation # nor does it submit to any jurisdiction. +""" +Expression layer of the two-level Loki IR based on `Pymbolic +