Add CMake based build system for CABLE offline #200
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 tasks
SeanBryan51
force-pushed
the
188-cmake-based-build-system
branch
from
6476b8c
to
9496936
Compare
SeanBryan51
commented
Jan 23, 2024
There was a problem hiding this comment.
TODO after this pull request:
- We should list the source files in alphabetical order (the current order is so that we preserve binary equivalence with the Makefile build).
- Use
find_package(MPI REQUIRED)instead of specifyingmpif90when invokingcmakefor MPI case. - Add simultaneous compilation of MPI and serial executables by creating a separate target for each executable.
- Remove MPI option from build script as the same can be achieved by specifying
--target cable-mpiwhen invoking CMake.
SeanBryan51
commented
Jan 23, 2024
SeanBryan51
force-pushed
the
188-cmake-based-build-system
branch
from
5d34dbf
to
ec3e56a
Compare
This was referenced Jan 23, 2024
SeanBryan51
force-pushed
the
188-cmake-based-build-system
branch
from
ec3e56a
to
a5f70cd
Compare
SeanBryan51
force-pushed
the
188-cmake-based-build-system
branch
4 times, most recently
from
ecba2bb
to
b54a2a1
Compare
SeanBryan51
commented
Jan 30, 2024
SeanBryan51
commented
Jan 31, 2024
SeanBryan51
force-pushed
the
188-cmake-based-build-system
branch
from
e1475bd
to
b95462c
Compare
|
Note, some links in the documentation are currently broken as they point to source files that were added in this pull request. To see the source files, replace |
|
@ccarouge is it worth supporting both Makefile and CMake based build systems? Or should we deprecate the Makefile build system in this pull request? |
harshula
reviewed
Feb 2, 2024
harshula
reviewed
Feb 7, 2024
For the record: we only want to support one build system. So this PR should deprecate the Makefile build system. |
SeanBryan51
force-pushed
the
188-cmake-based-build-system
branch
3 times, most recently
from
22896d4
to
b7aec13
Compare
SeanBryan51
force-pushed
the
188-cmake-based-build-system
branch
from
b7aec13
to
8caa102
Compare
This was
linked to
issues
Feb 28, 2024
Closed
ccarouge
approved these changes
Feb 28, 2024
documentation/docs/developer_guide/other_resources/build_system.md
Outdated
Show resolved
Hide resolved
SeanBryan51
force-pushed
the
188-cmake-based-build-system
branch
from
c2084b1
to
26d0136
Compare
SeanBryan51
force-pushed
the
188-cmake-based-build-system
branch
from
65b39ba
to
2bc0c31
Compare
ccarouge
reviewed
Feb 28, 2024
SeanBryan51
force-pushed
the
188-cmake-based-build-system
branch
from
2bc0c31
to
3d98226
Compare
Co-authored-by: Claire Carouge <[email protected]>
SeanBryan51
force-pushed
the
188-cmake-based-build-system
branch
from
3d98226
to
956304f
Compare
harshula
approved these changes
Mar 1, 2024
This was referenced Mar 1, 2024
SeanBryan51
added a commit
that referenced
this pull request
Mar 15, 2024
This pull request should follow after the CMake implementation (see #200). This change adds the following build system changes: - List source files in alphabetical order in CMakeLists.txt. The order of source files was previously chosen so that we could demonstrate binary equivalence in executables between the CMake build and the Makefile build. - Use [`find_package(MPI REQUIRED)`](https://cmake.org/cmake/help/latest/module/FindMPI.html) instead of specifying `mpif90` when invoking `cmake` for MPI case. This is done so that 1. We can create separate targets for the serial and MPI executable and only link against the MPI libraries when needed without relying on the MPI compiler wrapper. This lets us compile all executables (serial and parallel) with a single invocation of CMake. 2. We can use object libraries to compile the object files common to both serial and MPI builds. This saves compiling these object files for each executable (serial and MPI), reducing compilation time. - Portability fixes and improvements to build.bash. - Add `--compiler` flag to build.bash and GNU compiler support. - Add Matthias's configuration for example. Regression tests using [benchcab](https://github.com/CABLE-LSM/benchcab)* (bitwise comparison of model output via nccmp) show that model output is bitwise identical between the current branch and the main branch for serial and MPI model runs. *executables were built manually as benchcab does not yet support the recent build system changes (see related issue: CABLE-LSM/benchcab#258). Fixes #215 <!-- readthedocs-preview cable start --> ---- 📚 Documentation preview 📚: https://cable--216.org.readthedocs.build/en/216/ <!-- readthedocs-preview cable end -->
SeanBryan51
added a commit
to CABLE-LSM/benchcab
that referenced
this pull request
Apr 4, 2024
The CABLE build system was transitioned from Makefile to CMake: see CABLE-LSM/CABLE#216, CABLE-LSM/CABLE#200. This change adds support for building CABLE via CMake in benchcab so that CABLE versions which branch from the HEAD of main can be tested. Closes #258
SeanBryan51
added a commit
to CABLE-LSM/benchcab
that referenced
this pull request
Apr 4, 2024
The CABLE build system was transitioned from Makefile to CMake: see CABLE-LSM/CABLE#216, CABLE-LSM/CABLE#200. This change adds support for building CABLE via CMake in benchcab so that CABLE versions which branch from the HEAD of main can be tested. Closes #258
SeanBryan51
added a commit
to CABLE-LSM/benchcab
that referenced
this pull request
Apr 5, 2024
The CABLE build system was transitioned from Makefile to CMake: see CABLE-LSM/CABLE#216, CABLE-LSM/CABLE#200. This change adds support for building CABLE via CMake in benchcab so that CABLE versions which branch from the HEAD of main can be tested. Closes #258
SeanBryan51
added a commit
to CABLE-LSM/benchcab
that referenced
this pull request
Apr 5, 2024
The CABLE build system was transitioned from Makefile to CMake: see CABLE-LSM/CABLE#216, CABLE-LSM/CABLE#200. This change adds support for building CABLE via CMake in benchcab so that CABLE versions which branch from the HEAD of main can be tested. Closes #258
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In preparation for building CABLE with spack, @harshula, @ccarouge and I have found areas where the current build system for CABLE offline can be improved (see #188 for more details). This change adds a CMake based build system to address these issues:
Although this problem can be solved in the Makefile by specifying the relative paths to each source file, it requires updating all the Makefile Fortran module dependency rules which is a pain. CMake automatically handles Fortran module dependencies out of the box so doing this with CMake is much easier.
When invoking
cmake, custom options, compilers and compiler flags can be configurable by setting the appropriate variables via the-Dflag, for example:cmake -DCMAKE_Fortran_COMPILER="mpif90" -DCMAKE_Fortran_FLAGS="-O2 -fp-model precise" -S . -B build. These can be used for doing MPI only builds and enabling specific debug flags.As mentioned above, CMake automatically handles Fortran module dependencies out of the box. Parallelised builds can be done by specifying the
-jflag tocmake.The following pull requests should be merged before this pull request so that we can demonstrate binary equivalence between the executables compiled by both Makefile and CMake builds. This ensures no unwanted changes are introduced by the transition.
-O0flag fromLDFLAGS#197Edit: the above PR's have been merged - the serial and MPI binaries built by CMake (in release mode) are equivalent to the binaries built by the Makefile based build system in the main branch.
Fixes #188, #190, #191, #192
📚 Documentation preview 📚: https://cable--200.org.readthedocs.build/en/200/