Update installation doc #1183

AmishgaAlphonius · 2024-06-29T21:35:43Z

Description

This PR follows #1181 and updates documentation related to the installation of Lethe. More specifically, it corrects the version of p4est to be installed to 2.3.6.

Miscellaneous (will be removed when merged)

The STABLE_BUILD variable in candi.cfg was depricated. To get the developement release, simply specify the version master.
The updated version of Windows installation has not been tested yet.
The updated version of ARM installation has not been tested yet.

Checklist (will be removed when merged)

See this page for more information about the pull request process.

Code related list:

All in-code documentation related to this PR is up to date (Doxygen format)
Lethe documentation is up to date
The branch is rebased onto master
Code is indented with indent-all and .prm files (examples and tests) with prm-indent

Pull request related list:

Labels are applied
There are at least 2 reviewers (or 1 if small feature) excluding the responsible for the merge
If this PR closes an issue or is related to a project, it is linked in the "Projects" or "Development" section
If any future works is planed, an issue is opened
The PR description is cleaned and ready for merge

doc/source/installation/apple_arm.rst

doc/source/installation/regular_installation.rst

oguevremont · 2024-06-30T14:02:31Z

doc/source/installation/windows_wsl.rst

+  |     13 |                                                | .. code-block:: text                                                          |
+  |        |                                                |   :class: copy-button                                                         |
+  |        |                                                |                                                                               |
+  |        |                                                |   VERSION=2.3.6                                                               |
+  |        |                                                |   CHECKSUM=4b35d9cc374e3b05cd29c552070940124f04af8f8e5e01ff046e39833de5e153   |
+  +--------+------------------------------------------------+-------------------------------------------------------------------------------+


I like this format for adding new lines. I suggest we write it the same way for regular installation and Apple ARM

I was hesistating between both format, so I thought leaving them both here, the reviewers will tell me their opinion. Thanks for making the change!

Co-authored-by: Olivier Guévremont <guevremont.o@gmail.com>

doc/source/installation/apple_arm.rst

Co-authored-by: Olivier Guévremont <guevremont.o@gmail.com>

acdaigneault

I just want to add that the Trilinos version in the current Candi script had change to 14.0, which also require cmake 3.26 if you have an older version.
Do you think we could fork candi and modify everything according to our parameters?

acdaigneault · 2024-06-30T22:43:50Z

doc/source/installation/apple_arm.rst

+  +--------+------------------------------------------------+-------------------------------------------------------------------------------+
+  | line # | initial line                                   | changed line                                                                  |
+  +========+================================================+===============================================================================+
+  |     9  | ``VERSION=2.3.2``                              | ``#VERSION=2.3.2``                                                            |


Maybe we should just write to remove all that section and to add VERSION=2.3.6 ?

Also, the candi script changes over time, what is here may change

When reinstalling I indeed needed to update my cmake. I think if we want more control over the installation guide using candi a fork could be a good idea!

AmishgaAlphonius · 2024-06-30T23:06:07Z

I just want to add that the Trilinos version in the current Candi script had change to 14.0, which also require cmake 3.26 if you have an older version. Do you think we could fork candi and modify everything according to our parameters?

I think that's a great idea to make a fork, it would simplify the steps for users that are installing and therefore make it more accessible for them!
If @blaisb is fine with it, I could do so.
As for the Trilinos version, I was hesistating over it also, but as it is machine-dependent, I preferred not forcing a version, but I could change it for 13 on the fork (or doc), and leave a comment about it.

OresteMarquis

Nothing to add, changes are clear! I reinstalled deal.ii and Lethe on my windows computer at home using wsl and candi and everything worked!

blaisb · 2024-07-01T23:14:24Z

I agree with making a fork for candi, it's a good idea. I'm also a maintainer of CANDI so I could also make changes directly into the repository if we want

blaisb

Great work :)! I think this is ready for a merge.

blaisb · 2024-07-01T23:18:41Z

doc/source/installation/windows_wsl.rst

@@ -297,7 +301,7 @@ Where ``$numprocs`` corresponds to the number of processors used for the compila
 Installing Lethe (Step #2)
 -------------------------------------

-1. |linux_shell| Set-up the folder structure. Create the ``Software`` folder (if you are doing the candi installation, this folder should alredy exist from Step #1).
+1. |linux_shell| Set-up the folder structure. Create the ``Software`` folder (if you are doing the candi installation, this folder should already exist from Step #1).


The only thing I don't like is that Software here is with a capital letter. Haha. Otherwise, chill

Description This PR follows chaos-polymtl#1181 and updates documentation related to the installation of Lethe. More specifically, it corrects the version of p4est to be installed to 2.3.6. Co-authored-by: Olivier Guévremont <guevremont.o@gmail.com> Former-commit-id: 7405173

Description This PR follows #1181 and updates documentation related to the installation of Lethe. More specifically, it corrects the version of p4est to be installed to 2.3.6. Co-authored-by: Olivier Guévremont <guevremont.o@gmail.com> Former-commit-id: 7405173

AmishgaAlphonius added Documentation WIP When a PR is open but not ready for review labels Jun 29, 2024

AmishgaAlphonius self-assigned this Jun 29, 2024

AmishgaAlphonius force-pushed the update-installation-doc branch from 3d5f71b to 6bb957f Compare June 29, 2024 22:06

Update installation doc

d4b99b6

AmishgaAlphonius force-pushed the update-installation-doc branch from 6bb957f to d4b99b6 Compare June 29, 2024 22:07

AmishgaAlphonius requested review from blaisb and oguevremont June 29, 2024 22:09

AmishgaAlphonius added Ready for review and removed WIP When a PR is open but not ready for review labels Jun 29, 2024

AmishgaAlphonius marked this pull request as ready for review June 29, 2024 22:14

AmishgaAlphonius requested a review from OresteMarquis June 30, 2024 01:41

oguevremont reviewed Jun 30, 2024

View reviewed changes

Integrate new lines in the table

5bb35a7

oguevremont force-pushed the update-installation-doc branch from 133eb73 to 5bb35a7 Compare June 30, 2024 14:06

AmishgaAlphonius and others added 2 commits June 30, 2024 10:49

Update doc/source/installation/apple_arm.rst

9f2eac9

Co-authored-by: Olivier Guévremont <guevremont.o@gmail.com>

Update doc/source/installation/regular_installation.rst

552f054

Co-authored-by: Olivier Guévremont <guevremont.o@gmail.com>

oguevremont approved these changes Jun 30, 2024

View reviewed changes

doc/source/installation/apple_arm.rst Outdated Show resolved Hide resolved

AmishgaAlphonius and others added 2 commits June 30, 2024 18:45

Apply suggestions from code review

8c6a264

Co-authored-by: Olivier Guévremont <guevremont.o@gmail.com>

Fix table indentation

5a17a18

acdaigneault reviewed Jun 30, 2024

View reviewed changes

AmishgaAlphonius added WIP When a PR is open but not ready for review and removed Ready for review labels Jul 1, 2024

AmishgaAlphonius mentioned this pull request Jul 1, 2024

Update files for Lethe installation chaos-polymtl/candi#1

Open

OresteMarquis approved these changes Jul 1, 2024

View reviewed changes

blaisb approved these changes Jul 1, 2024

View reviewed changes

blaisb merged commit 7405173 into master Jul 1, 2024

blaisb deleted the update-installation-doc branch July 1, 2024 23:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update installation doc #1183

Update installation doc #1183

AmishgaAlphonius commented Jun 29, 2024 •

edited

Loading

oguevremont Jun 30, 2024

AmishgaAlphonius Jun 30, 2024 •

edited

Loading

acdaigneault left a comment

acdaigneault Jun 30, 2024

acdaigneault Jun 30, 2024

OresteMarquis Jul 1, 2024

AmishgaAlphonius commented Jun 30, 2024 •

edited

Loading

OresteMarquis left a comment

blaisb commented Jul 1, 2024

blaisb left a comment

blaisb Jul 1, 2024

Update installation doc #1183

Update installation doc #1183

Conversation

AmishgaAlphonius commented Jun 29, 2024 • edited Loading

Description

Miscellaneous (will be removed when merged)

Checklist (will be removed when merged)

oguevremont Jun 30, 2024

Choose a reason for hiding this comment

AmishgaAlphonius Jun 30, 2024 • edited Loading

Choose a reason for hiding this comment

acdaigneault left a comment

Choose a reason for hiding this comment

acdaigneault Jun 30, 2024

Choose a reason for hiding this comment

acdaigneault Jun 30, 2024

Choose a reason for hiding this comment

OresteMarquis Jul 1, 2024

Choose a reason for hiding this comment

AmishgaAlphonius commented Jun 30, 2024 • edited Loading

OresteMarquis left a comment

Choose a reason for hiding this comment

blaisb commented Jul 1, 2024

blaisb left a comment

Choose a reason for hiding this comment

blaisb Jul 1, 2024

Choose a reason for hiding this comment

AmishgaAlphonius commented Jun 29, 2024 •

edited

Loading

AmishgaAlphonius Jun 30, 2024 •

edited

Loading

AmishgaAlphonius commented Jun 30, 2024 •

edited

Loading