feat: provide patch for difference of tests from CLEO v0.39.0

0001-refactor-comment-out-checking-initialisation-for-gbx.patch

@@ -0,0 +1,46 @@
+From c505dfbe747360ed5de8485421be338db3c3e398 Mon Sep 17 00:00:00 2001
+From: "clara.bayley" <yoctoyotta1024@yahoo.com>
+Date: Tue, 25 Mar 2025 17:45:12 +0100
+Subject: [PATCH] refactor: comment out checking initialisation for gbxs and
+ sds
+
+temporary measure until future version of cleo only includes these checks in debugging builds
+---
+ libs/runcleo/creategbxs.hpp   | 6 +++---
+ libs/runcleo/createsupers.hpp | 4 ++--
+ 2 files changed, 5 insertions(+), 5 deletions(-)
+
+diff --git a/libs/runcleo/creategbxs.hpp b/libs/runcleo/creategbxs.hpp
+index 51e604a2..6219e075 100644
+--- a/libs/runcleo/creategbxs.hpp
++++ b/libs/runcleo/creategbxs.hpp
+@@ -268,9 +268,9 @@ dualview_gbx create_gbxs(const GbxMaps &gbxmaps, const GbxInitConds &gbxic,
+   const auto domainsupers = allsupers.domain_supers_readonly();
+   const auto gbxs = initialise_gbxs(gbxmaps, gbxic, domainsupers);
+
+-  std::cout << "checking initialisation\n";
+-  is_gbxinit_complete(gbxmaps.get_local_ngridboxes_hostcopy(), gbxs,
+-                      allsupers.get_totsupers_readonly());
++  // std::cout << "checking initialisation\n";
++  // is_gbxinit_complete(gbxmaps.get_local_ngridboxes_hostcopy(), gbxs,
++  //                     allsupers.get_totsupers_readonly());
+
+   // // Print information about the created superdrops
+   // print_gbxs(gbxs.view_host());
+diff --git a/libs/runcleo/createsupers.hpp b/libs/runcleo/createsupers.hpp
+index c1d5b45e..7e1415e2 100644
+--- a/libs/runcleo/createsupers.hpp
++++ b/libs/runcleo/createsupers.hpp
+@@ -124,8 +124,8 @@ SupersInDomain create_supers(const SuperdropInitConds &sdic, const unsigned int
+   auto allsupers = SupersInDomain(totsupers, gbxindex_max);
+
+   // Log message and perform checks on the initialisation of superdrops
+-  std::cout << "checking initialisation\n";
+-  is_sdsinit_complete(allsupers);
++  // std::cout << "checking initialisation\n";
++  // is_sdsinit_complete(allsupers);
+
+   // // Print information about the created superdrops
+   // print_supers(totsupers);
+--
+2.43.7

docs/source/index.rst

@@ -5,19 +5,13 @@
 Welcome to PerformanceTestingCLEO's Documentation!
 ==================================================
 
-.. note::
-   Please consider that this project is under active development
-   and our documentation is a work in progress.
-
-   This documentation is built from the latest code in the main branch of the repository.
-   It does not necessarily reflect a released version, and there may be short-commings when compared
-   to the on-going code development. If you have queries related to
-   this or if there is anything you wish to report please please :ref:`contact us! <contact>`.
-
 This repository has been made to document the performance tests of CLEO on Levante for CLEO's
-first model description paper.
+first model description paper. Specifically it tests the branch ``performance_testing_cleo``, which
+is the same as CLEO ``v0.39.0`` with the patch
+``0001-refactor-comment-out-checking-initialisation-for-gbx.patch`` applied.
 
-To (locally) reproduce this project, simply clone the repository. You will need to setup an
+To (locally) reproduce this project, simply clone this repository and ``CLEO`` and checkout ``CLEO``
+to the ``performance_testing_cleo`` branch (or apply the patch). You will need to setup an
 environment with the dependencies installed and then run ``pre-commit install``, but other than
 that everything should work out of the box and you can now run & have fun with the project...
 If not, please raise an issue on the GitHub repository.