From 485fedf13f88bab02243c9ec1248af3a5388afca Mon Sep 17 00:00:00 2001 From: Axel Huebl Date: Fri, 12 Jan 2024 10:07:39 -0800 Subject: [PATCH] CCache Notes --- Docs/source/developers/local_compile.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/Docs/source/developers/local_compile.rst b/Docs/source/developers/local_compile.rst index 53b897f3d34..e534a1662c1 100644 --- a/Docs/source/developers/local_compile.rst +++ b/Docs/source/developers/local_compile.rst @@ -13,7 +13,7 @@ For simplicity, WarpX :ref:`compilation with CMake ` by default on-the-fly, which is called a *superbuild*. -In some scenarios, e.g., when compiling without internet, with slow internet access, or when working on WarpX and its dependencies, other strategies might be preferable. +In some scenarios, e.g., when compiling without internet, with slow internet access, or when working on WarpX and its dependencies, modifications to the superbuild strategy might be preferable. In the below workflows, you as the developer need to make sure to use compatible versions of the dependencies you provide. @@ -123,3 +123,14 @@ When developing without internet or after the first ``pip_install`` succeeded in .. code-block:: bash cmake --build build -j 8 --target pip_install_nodeps + + +.. _developers-local-compile-ccache: + +CCache +------ + +WarpX builds will automatically search for `CCache `__ to speed up subsequent compilations in development cycles. +Make sure a :ref:`recent CCache version ` is installed to make use of this feature. + +For power developers that switch a lot between fundamentally different WarpX configurations (e.g., 1D to 3D, GPU and CPU builds, many branches with different bases, developing AMReX and WarpX at the same time), also consider increasing the `CCache cache size `__ and changing the `cache directory `__ if needed, e.g., due to storage quota constraints or to choose a fast(er) filesystem for the cache files.