Skip to content

Commit

Permalink
CCache Notes
Browse files Browse the repository at this point in the history
  • Loading branch information
ax3l committed Jan 12, 2024
1 parent 9c71e75 commit 485fedf
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion Docs/source/developers/local_compile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For simplicity, WarpX :ref:`compilation with CMake <building-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.


Expand Down Expand Up @@ -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 <https://ccache.dev>`__ to speed up subsequent compilations in development cycles.
Make sure a :ref:`recent CCache version <install-dependencies>` 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 <https://ccache.dev/manual/4.9.html#_cache_size_management>`__ and changing the `cache directory <https://ccache.dev/manual/4.9.html#config_cache_dir>`__ if needed, e.g., due to storage quota constraints or to choose a fast(er) filesystem for the cache files.

0 comments on commit 485fedf

Please sign in to comment.