build: Add CMake build #3621

HuidaeCho · 2024-04-18T08:29:55Z

This PR replaces #3021. Branched from https://github.com/nilason/grass/tree/cmake_build_work. Thanks @nilason!

Current status: I can compile the entire gisbase using CMake 3.29.1 and GCC 13.2.0. Running grass directly from build/gisbase works fine.

Windows Tests

For my records, message from message(WIN32=${WIN32}, MSVC=${MSVC}, MSYS=${MSYS}, MINGW=${MINGW}) on Windows (all from cmd in ssh):

Using MSYS cmake (cmd for MSVC): WIN32=,MSVC=,MSYS=1,MINGW= (WIN32 not set?)
- CMake no longer defines WIN32 on MSYS xmrig/xmrig#950
- https://developercommunity.visualstudio.com/t/win32-not-defined/722576
Using MinGW-w64 cmake (bash for MinGW-w64 GCC): WIN32=1,MSVC=,MSYS=,MINGW=1

CMake variables:

TODOs

Windows
macOS
locale
addon support
...

Documentation

@Mahesh1998 and I are testing, fixing, and documenting this PR on Ubuntu. https://github.com/Mahesh1998/grass-docs/blob/main/cmake_build_docs/

Building on Windows

Install Visual Studio Community Edition. Select these two components:
- MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest)
- Windows 11 SDK (10.0.26100.0)
Install Git for Windows
Install GitHub CLI
Install Miniconda

curl -O https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe
Miniconda3-latest-Windows-x86_64.exe /S /D=C:\opt\miniconda
C:\opt\miniconda\condabin\conda.bat init

Start Developer Command Prompt for VS 2022
Setup Conda for GRASS build

conda config --add channels conda-forge
conda config --set channel_priority strict
conda create -n grass cmake pkg-config winflexbison proj libgdal pcre fftw openblas pdal wxpython pywin32

Download the source code

git clone [email protected]:OSGeo/grass.git
cd grass
gh auth login
gh repo set-default
gh pr checkout 3621

Build!

conda activate grass

mkdir build
cd build
cmake .. -DWITH_OPENGL=OFF > cmake.log 2>&1
msbuild grass.sln > msbuild.log 2>&1

Building on Slackware with Conda packages

Install Miniconda

wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
chmod a+x Miniconda3-latest-Linux-x86_64.sh
./Miniconda3-latest-Linux-x86_64.sh -b -u -p ~/usr/local/opt/miniconda
~/usr/local/opt/miniconda/bin/conda init
. ~/.bashrc
conda config --add channels conda-forge
conda config --set channel_priority strict

Create a new environment and install libraries

conda create -n grass proj libgdal fftw blas libpdal wxpython
conda activate grass

Build GRASS

mkdir build
cd build
# ignore warnings about runtime path (Conda libraries will be picked over system libraries)
cmake .. -DCMAKE_PREFIX_PATH=$HOME/usr/local/opt/miniconda/envs/grass
make -j`nproc`

Run GRASS

./output/bin/grass

CMakeLists.txt

cmake/modules/CheckDependentLibraries.cmake

lib/external/ccmath/ccmath.h

lib/gis/user_config.c

raster/r.terraflow/filldepr.cpp

raster/r.terraflow/main.cpp

HuidaeCho · 2024-04-21T17:08:07Z

Current status: I can compile the entire gisbase using CMake 3.29.1 and GCC 13.2.0. Running grass directly from build/gisbase works fine.

For my records, message from message(WIN32=${WIN32}, MSVC=${MSVC}, MSYS=${MSYS}, MINGW=${MINGW}) on Windows (all from cmd in ssh):

Using MSYS cmake (cmd for MSVC): WIN32=,MSVC=,MSYS=1,MINGW= (WIN32 not set?)
- CMake no longer defines WIN32 on MSYS xmrig/xmrig#950
- https://developercommunity.visualstudio.com/t/win32-not-defined/722576
Using MinGW-w64 cmake (bash for MinGW-w64 GCC): WIN32=1,MSVC=,MSYS=,MINGW=1

CMake variables:

echoix

I did what I could to help out on this feature (that I really want) with what I'm good with, the CI. I made them as code suggestions to be easier to apply without being tedious.

lib/init/env.sh

.github/workflows/cmake.yml

HuidaeCho · 2024-04-22T13:26:14Z

I did what I could to help out on this feature (that I really want) with what I'm good with, the CI. I made them as code suggestions to be easier to apply without being tedious.

@echoix What YAML formatter should I use (e.g., working with pre-commit yamllint)? Are we/you already using one?

nilason · 2024-04-22T13:35:24Z

I did what I could to help out on this feature (that I really want) with what I'm good with, the CI. I made them as code suggestions to be easier to apply without being tedious.

@echoix What YAML formatter should I use (e.g., working with pre-commit yamllint)? Are we/you already using one?

pre-commit is using:

grass/.pre-commit-config.yaml

Lines 68 to 75 in 7413740

    
             - repo: https://github.com/adrienverge/yamllint.git 
        
               rev: v1.29.0 
        
               hooks: 
        
                 - id: yamllint 
        
                   args: [--format, parsable, --strict, -d, 
        
                          '{extends: default, rules: {truthy: disable, 
        
                            line-length: {max: 120, allow-non-breakable-words: true}, 
        
                            comments: {min-spaces-from-content: 1}}}']

HuidaeCho · 2024-04-22T13:39:07Z

I did what I could to help out on this feature (that I really want) with what I'm good with, the CI. I made them as code suggestions to be easier to apply without being tedious.

@echoix What YAML formatter should I use (e.g., working with pre-commit yamllint)? Are we/you already using one?

pre-commit is using:

grass/.pre-commit-config.yaml

Lines 68 to 75 in 7413740

- repo: https://github.com/adrienverge/yamllint.git

rev: v1.29.0

hooks:

- id: yamllint

args: [--format, parsable, --strict, -d,

'{extends: default, rules: {truthy: disable,

line-length: {max: 120, allow-non-breakable-words: true},

comments: {min-spaces-from-content: 1}}}']

Can I use yamllint for formatting? Looks like, it only checks, not format.

nilason · 2024-04-22T13:46:09Z

Can I use yamllint for formatting?

No.

Looks like, it only checks, not format.

Yes, it is only a linter ("checker") not formatter.

nilason · 2024-04-22T14:16:42Z

I have just tried this PR out and you've come a long way!
I hit some obstacles configuring/building on Mac, if you reached the point to receive a "pre-review" I'm glad to share my experiences.

nilason · 2025-02-22T14:28:16Z

Green!

wenzeslaus

Awesome! What a great achievement! Thanks for all the hard work.

HuidaeCho · 2025-02-22T16:06:53Z

Awesome! What a great achievement! Thanks for all the hard work.

Just one more approval away!

hellik · 2025-02-22T16:14:29Z

Is there any how-to available for testing locally in Windows?

HuidaeCho · 2025-02-22T16:15:06Z

Is there any how-to available for testing locally in Windows?

Please see the first block in this PR. Building on Windows.

nilason

Great teamwork, thank you all!

There's still a way for full functionality, but a very important milestone.

nilason · 2025-02-22T16:53:02Z

(The CI runner creates a testreport artefact, testing rate is now set at 72 per cent, so the report presents a convenient status update).

nilason · 2025-02-22T16:57:20Z

Note the CI speed for CMake, 22 mins, with full tests on ubuntu.

echoix · 2025-02-22T17:02:28Z

Note the CI speed for CMake, 22 mins, with full tests on ubuntu.

1 min 30s to configure+build. (Instead of 4 min now)!!. Both without cache, but the 4 minutes also uses a faster linker. Here I don't think the markdown docs and/or normal html docs are handled yet, and at least we don't uselessly (and inefficiently) create .pyc files at the wrong locations. I'm curious if make vs ninja has something to do here, or simply because the rules are now better defined. There's also some build flags that we use in the 4 minutes of equivalent CI runs that I know take a little longer than without.

nilason · 2025-02-22T17:04:50Z

I repost the draft commit message, for easy access, note: email addresses need to be filled in:

cmake: initial commit adding CMake support

Based on original work by Rashad Kanavath in 2020 with pull request:
https://github.com/OSGeo/grass/pull/289

This update introduces preliminary support for building and installing
GRASS GIS using CMake across multiple platforms, including Windows with
MSVS, Linux, and macOS. The installation can be performed using either
the traditional GRASS file structure or a structure that complies with
the Filesystem Hierarchy Standard (FHS).

Co-authored-by: @rkanavath
Co-authored-by: @neteler
Co-authored-by: Loïc Bartoletti <[email protected]>
Co-authored-by: Aaron Saw <[email protected]>
Co-authored-by: Nicklas Larsson <[email protected]>
Co-authored-by: Huidae Cho <[email protected]>
Co-authored-by: Mahesh Maddineni <[email protected]>
Co-authored-by: Kandel Nelson <[email protected]>
Co-authored-by: Edouard Choinière <[email protected]>

HuidaeCho · 2025-02-22T17:22:40Z

Update branch doesn't seem to work?

Response.json: Body has already been consumed.

echoix · 2025-02-22T17:24:58Z

Update branch doesn't seem to work?

We have the setting enabled to always show it (when the PR is not exactly up to date with the latest commit on the target branch). That means it's always an option, not that there is a problem with the PR and the merge won't be clean, merging would have worked anyway.

HuidaeCho · 2025-02-22T17:29:54Z

Update branch doesn't seem to work?

We have the setting enabled to always show it (when the PR is not exactly up to date with the latest commit on the target branch). That means it's always an option, not that there is a problem with the PR and the merge won't be clean, merging would have worked anyway.

I can only see "Enable auto-merge (squash)" without the green Merge button. Just Updated branch and waiting...

echoix · 2025-02-22T17:33:37Z

Maybe there was still open conversations, but now the required jobs need to finish since it was updated.

HuidaeCho · 2025-02-22T19:18:42Z

cmake: initial commit adding CMake support

Based on original work by Rashad Kanavath in 2020 with pull request:
#289

This update introduces preliminary support for building and installing
GRASS GIS using CMake across multiple platforms, including Windows with
MSVS, Linux, and macOS. The installation can be performed using either
the traditional GRASS file structure or a structure that complies with
the Filesystem Hierarchy Standard (FHS).

Co-authored-by: @rkanavath
Co-authored-by: @neteler
Co-authored-by: Loïc Bartoletti [email protected]
Co-authored-by: Aaron Saw [email protected]
Co-authored-by: Nicklas Larsson [email protected]
Co-authored-by: Huidae Cho [email protected]
Co-authored-by: Mahesh Maddineni [email protected]
Co-authored-by: Kandel Nelson [email protected]
Co-authored-by: Edouard Choinière [email protected]

Almost forgot... Will I see a textbox for this when I click Squash and merge?

HuidaeCho · 2025-02-22T19:27:09Z

@nilason, What about this with GitHub handles?

cmake: initial commit adding CMake support

Based on original work by Rashad Kanavath in 2020 with pull request:
https://github.com/OSGeo/grass/pull/289

This update introduces preliminary support for building and installing
GRASS GIS using CMake across multiple platforms, including Windows with
MSVS, Linux, and macOS. The installation can be performed using either
the traditional GRASS file structure or a structure that complies with
the Filesystem Hierarchy Standard (FHS).

Co-authored-by: @rkanavath
Co-authored-by: @neteler
Co-authored-by: @lbartoletti
Co-authored-by: @aaronsms
Co-authored-by: @nilason
Co-authored-by: @HuidaeCho
Co-authored-by: @Mahesh1998
Co-authored-by: @KandelN
Co-authored-by: @echoix

nilason · 2025-02-22T19:31:33Z

@nilason, What about this with GitHub handles?

cmake: initial commit adding CMake support

Based on original work by Rashad Kanavath in 2020 with pull request:
https://github.com/OSGeo/grass/pull/289

This update introduces preliminary support for building and installing
GRASS GIS using CMake across multiple platforms, including Windows with
MSVS, Linux, and macOS. The installation can be performed using either
the traditional GRASS file structure or a structure that complies with
the Filesystem Hierarchy Standard (FHS).

Co-authored-by: @rkanavath
Co-authored-by: @neteler
Co-authored-by: @lbartoletti
Co-authored-by: @aaronsms
Co-authored-by: @nilason
Co-authored-by: @HuidaeCho
Co-authored-by: @Mahesh1998
Co-authored-by: @KandelN
Co-authored-by: @echoix

Would be better with the actual email addresses, please search in git log. I just didn't want to put them out here.

HuidaeCho · 2025-02-22T19:32:45Z

@nilason, What about this with GitHub handles?

cmake: initial commit adding CMake support

Based on original work by Rashad Kanavath in 2020 with pull request:
https://github.com/OSGeo/grass/pull/289

This update introduces preliminary support for building and installing
GRASS GIS using CMake across multiple platforms, including Windows with
MSVS, Linux, and macOS. The installation can be performed using either
the traditional GRASS file structure or a structure that complies with
the Filesystem Hierarchy Standard (FHS).

Co-authored-by: @rkanavath
Co-authored-by: @neteler
Co-authored-by: @lbartoletti
Co-authored-by: @aaronsms
Co-authored-by: @nilason
Co-authored-by: @HuidaeCho
Co-authored-by: @Mahesh1998
Co-authored-by: @KandelN
Co-authored-by: @echoix

Would be better with the actual email addresses, please search in git log. I just didn't want to put them out here.

Oops.. If so, deleting my comment ;-)

nilason · 2025-02-22T19:33:22Z

Almost forgot... Will I see a textbox for this when I click Squash and merge?

Yes, there will be a single line where cmake: initial commit adding CMake support will go. The rest will go to the box.

HuidaeCho · 2025-02-22T19:36:16Z

Finally MERGED after 5 years of work!!! Thanks everyone!

nilason · 2025-02-22T19:41:11Z

(@HuidaeCho I'll delete the post where the "accident" occurred. )

nilason · 2025-02-22T19:41:46Z

(Never mind!)

echoix · 2025-02-22T23:17:41Z

Is there a place where we can list some small issues all at one place?

HuidaeCho · 2025-02-23T01:03:07Z

Is there a place where we can list some small issues all at one place?

Something like this? #5192

HuidaeCho mentioned this pull request Apr 18, 2024

build: Add CMake build #3021

Closed

21 tasks

echoix reviewed Apr 18, 2024

View reviewed changes

CMakeLists.txt Outdated Show resolved Hide resolved

HuidaeCho marked this pull request as draft April 18, 2024 12:30

echoix reviewed Apr 20, 2024

View reviewed changes

CMakeLists.txt Outdated Show resolved Hide resolved

echoix reviewed Apr 20, 2024

View reviewed changes

cmake/modules/CheckDependentLibraries.cmake Show resolved Hide resolved

github-actions bot reviewed Apr 21, 2024

View reviewed changes

HuidaeCho self-assigned this Apr 21, 2024

echoix reviewed Apr 22, 2024

View reviewed changes

chmod

8cc3dc8

wenzeslaus approved these changes Feb 22, 2025

View reviewed changes

echoix approved these changes Feb 22, 2025

View reviewed changes

Merge branch 'main' into cmake_build_work

25a0759

nilason approved these changes Feb 22, 2025

View reviewed changes

Merge branch 'main' into cmake_build_work

4a3e47c

Merge branch 'main' into cmake_build_work

7d73112

HuidaeCho merged commit c12df29 into OSGeo:main Feb 22, 2025
28 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build: Add CMake build #3621

build: Add CMake build #3621

HuidaeCho commented Apr 18, 2024 •

edited

Loading

HuidaeCho commented Apr 21, 2024 •

edited

Loading

echoix left a comment

HuidaeCho commented Apr 22, 2024 •

edited

Loading

nilason commented Apr 22, 2024

HuidaeCho commented Apr 22, 2024

nilason commented Apr 22, 2024

nilason commented Apr 22, 2024

nilason commented Feb 22, 2025

wenzeslaus left a comment

HuidaeCho commented Feb 22, 2025

hellik commented Feb 22, 2025

HuidaeCho commented Feb 22, 2025 •

edited

Loading

nilason left a comment

nilason commented Feb 22, 2025

nilason commented Feb 22, 2025

echoix commented Feb 22, 2025

nilason commented Feb 22, 2025 •

edited by neteler

Loading

HuidaeCho commented Feb 22, 2025 •

edited

Loading

echoix commented Feb 22, 2025 •

edited

Loading

HuidaeCho commented Feb 22, 2025

echoix commented Feb 22, 2025

HuidaeCho commented Feb 22, 2025

HuidaeCho commented Feb 22, 2025

nilason commented Feb 22, 2025

HuidaeCho commented Feb 22, 2025

nilason commented Feb 22, 2025

HuidaeCho commented Feb 22, 2025 •

edited

Loading

nilason commented Feb 22, 2025

nilason commented Feb 22, 2025

echoix commented Feb 22, 2025

HuidaeCho commented Feb 23, 2025

build: Add CMake build #3621

build: Add CMake build #3621

Conversation

HuidaeCho commented Apr 18, 2024 • edited Loading

Windows Tests

TODOs

Documentation

Building on Windows

Building on Slackware with Conda packages

HuidaeCho commented Apr 21, 2024 • edited Loading

echoix left a comment

Choose a reason for hiding this comment

HuidaeCho commented Apr 22, 2024 • edited Loading

nilason commented Apr 22, 2024

HuidaeCho commented Apr 22, 2024

nilason commented Apr 22, 2024

nilason commented Apr 22, 2024

nilason commented Feb 22, 2025

wenzeslaus left a comment

Choose a reason for hiding this comment

HuidaeCho commented Feb 22, 2025

hellik commented Feb 22, 2025

HuidaeCho commented Feb 22, 2025 • edited Loading

nilason left a comment

Choose a reason for hiding this comment

nilason commented Feb 22, 2025

nilason commented Feb 22, 2025

echoix commented Feb 22, 2025

nilason commented Feb 22, 2025 • edited by neteler Loading

HuidaeCho commented Feb 22, 2025 • edited Loading

echoix commented Feb 22, 2025 • edited Loading

HuidaeCho commented Feb 22, 2025

echoix commented Feb 22, 2025

HuidaeCho commented Feb 22, 2025

HuidaeCho commented Feb 22, 2025

nilason commented Feb 22, 2025

HuidaeCho commented Feb 22, 2025

nilason commented Feb 22, 2025

HuidaeCho commented Feb 22, 2025 • edited Loading

nilason commented Feb 22, 2025

nilason commented Feb 22, 2025

echoix commented Feb 22, 2025

HuidaeCho commented Feb 23, 2025

HuidaeCho commented Apr 18, 2024 •

edited

Loading

HuidaeCho commented Apr 21, 2024 •

edited

Loading

HuidaeCho commented Apr 22, 2024 •

edited

Loading

HuidaeCho commented Feb 22, 2025 •

edited

Loading

nilason commented Feb 22, 2025 •

edited by neteler

Loading

HuidaeCho commented Feb 22, 2025 •

edited

Loading

echoix commented Feb 22, 2025 •

edited

Loading

HuidaeCho commented Feb 22, 2025 •

edited

Loading