https://github.com/fortran-lang/stdlib-cmake-example
Integration of the Fortran standard library in CMake projects
https://github.com/fortran-lang/stdlib-cmake-example
cmake fortran stdlib
Last synced: 2 months ago
JSON representation
Integration of the Fortran standard library in CMake projects
- Host: GitHub
- URL: https://github.com/fortran-lang/stdlib-cmake-example
- Owner: fortran-lang
- License: mit
- Created: 2020-12-29T15:26:58.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-11T08:10:11.000Z (over 3 years ago)
- Last Synced: 2024-12-30T09:29:23.711Z (4 months ago)
- Topics: cmake, fortran, stdlib
- Language: Fortran
- Homepage:
- Size: 16.6 KB
- Stars: 13
- Watchers: 17
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Using stdlib in your project
The Fortran standard library ([stdlib](https://github.com/fortran-lang/stdlib)) is developed by the [Fortran-lang community](https://github.com/fortran-lang).
This projects shows how to integrate stdlib in your CMake project.
For a quick start you can include stdlib as git submodule in your projects by
```
git submodule https://github.com/fortran-lang/stdlib subprojects/stdlib
```
Users must initialize the submodule themselves when building your project, unless you let CMake perform this operation on demand.
Alternatively, you can use the `FetchContent` module of CMake to retrieve the git repository while configuring the project.
A CMake snippet supporting both approaches is given here
```cmake
# Include the stdlib project
if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/stdlib/CMakeLists.txt)
add_subdirectory("stdlib")
else()
set("stdlib-url" "https://github.com/fortran-lang/stdlib")
message(STATUS "Retrieving stdlib from ${stdlib-url}")
include(FetchContent)
FetchContent_Declare(
"stdlib"
GIT_REPOSITORY "${stdlib-url}"
GIT_TAG "HEAD"
)
FetchContent_MakeAvailable("stdlib")
endif()
```
A more elaborated CMake module for making stdlib available can be found [here](config/cmake/Findfortran_stdlib.cmake).
This module makes sure the ``fortran_stdlib::fortran_stdlib`` target is always generated regardless of how the stdlib is included in the project.
You can configure stdlib by setting the appropriate options before including the subproject.
Important options are
- `BUILD_SHARED_LIBS` should be set to off if you want to link statically against stdlib
- `CMAKE_MAXIMUM_RANK` determines the maximum rank of arrays supported in stdlib, the default value is 15.
To save compile time you can reduce this value to the maximum rank needed in your application.
This project offers a ready to use integration of stdlib for CMake, including an exported library and a binary application.
Additionally, some boilerplate text in the README is available below as well as a testing setup with GitHub actions for GCC.
The general CMake style should allow you to reuse most of the CMake build files *without* modification, just change the project name, add your source files and you are ready to go.
You can [just *use this template* to create new project](https://github.com/fortran-lang/stdlib-cmake-example/generate).
Remove this introduction from the README afterwards and fill in your project details.
For more information on stdlib visit its [documentation](https://stdlib.fortran-lang.org).
## Installation
To build this project you need
- A Fortran compiler supporting Fortran 2008 or later (`gfortran` or `ifort`)
- CMake version 3.14 or later
- The [fypp](https://github.com/aradi/fypp) preprocessor
- A build backend, ninja (version 1.10 or newer) or make
Configure the build with (set the `CMAKE_INSTALL_PREFIX` to your preferred install location)
```
cmake -B _build -G Ninja -DCMAKE_INSTALL_PREFIX=$HOME/.local
```
To build the project run
```
cmake --build _build
```
Finally, you can install the project with
```
cmake --install _build
```
## License
This project is free software: you can redistribute it and/or modify it under the terms of the [MIT license](LICENSE).