[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[reza via Guix-patches via]

This is a patch series updating OpenFoam to version 10. This series gets rid
of the OpenFoam patch file and also adds the OpenFoam build from openfoam.com
(therefore the distinction with openfoam-org and openfoam-com).  Some effort
was put forward to build the two packages with the same instructions as the
sources are still very similar.  There is a strange issue that inside the
build of openfoam-com which inherits from openfoam-org, the version of
openfoam-org is used. Maybe this is a bug? Furthermore the dependencies and
build instructions have been updated to build the paraview plugin for OpenFoam
and the OpenFoam tests (only available for openfoam-org).

Reza Housseini (4):
  gnu: Add ftest.
  gnu: utfcpp: Update to 3.2.3.
  gnu: Add openfoam-org.
  gnu: Add openfoam-com.

 gnu/local.mk                                  |   2 +-
 gnu/packages/check.scm                        |  34 ++
 .../patches/openfoam-4.1-cleanup.patch        | 243 ----------
 gnu/packages/simulation.scm                   | 432 ++++++++++++------
 gnu/packages/textutils.scm                    |  35 +-
 5 files changed, 346 insertions(+), 400 deletions(-)
 delete mode 100644 gnu/packages/patches/openfoam-4.1-cleanup.patch


base-commit: de84b24613afa4020f3f0553dad8e39a78d1f92c
-- 
2.39.2

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[reza via Guix-patches via]

[-- Attachment #1: Type: text/plain, Size: 68 bytes --]

This would also resolve [1].

[1] https://issues.guix.gnu.org/51071

[-- Attachment #2: OpenPGP_0xC375C6AF05125C52.asc --]
[-- Type: application/pgp-keys, Size: 15557 bytes --]

[-- Attachment #3: OpenPGP_signature --]
[-- Type: application/pgp-signature, Size: 499 bytes --]

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[Ludovic Courtès]

Hi Reza,

Great work, it’s good to have an OpenFoam update!

Some comments follow.

reza <reza@housseini.me> skribis:

> From: Reza Housseini <reza.housseini@gmail.com>
> 
> ---
>  gnu/packages/check.scm | 34 ++++++++++++++++++++++++++++++++++
>  1 file changed, 34 insertions(+)

Your mail user agent apparently added DOS-style line endings, which I
think is the reason why <https://qa.guix.gnu.org/issue/62473> doesn’t
have any info.

Could you try to use ‘git send-email’ in the future, to avoid that kind
of issue?

> +(define-public ftest
> +  (package
> +    (name "ftest")
> +    (version "bf75576064fce2e07f52cd63a3e410f12358728b")

That’s not a reasonable version string; see
<https://guix.gnu.org/manual/devel/en/html_node/Version-Numbers.html>
on how to derive version strings for Git checkouts.

Furthermore, when packaging a snapshot (as opposed to a tagged release),
please add a short comment explaining why we’re not providing a release.

> +    (build-system copy-build-system)
> +    (native-inputs (list cmake-minimal))

Perhaps use ‘cmake-build-system’?

> +    (synopsis "Simple and limited unit-test framework for C++")
> +    (description "A simple and limited unit-test framework for C++")

Please write a full sentence:

  https://guix.gnu.org/manual/devel/en/html_node/Synopses-and-Descriptions.html

Ludo’.

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[Ludovic Courtès]

reza <reza@housseini.me> skribis:

> From: Reza Housseini <reza.housseini@gmail.com>
> 
> ---
>  gnu/packages/textutils.scm | 35 +++++++++++++++++++----------------
>  1 file changed, 19 insertions(+), 16 deletions(-)

This one LGTM, as long as dependents shown by ‘guix refresh -l utfcpp’
still work after this.

Ludo’.

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[Ludovic Courtès]

reza <reza@housseini.me> skribis:

> ---
>  gnu/local.mk                                  |   1 -
>  .../patches/openfoam-4.1-cleanup.patch        | 243 -----------
>  gnu/packages/simulation.scm                   | 405 ++++++++++++------
>  3 files changed, 263 insertions(+), 386 deletions(-)
>  delete mode 100644 gnu/packages/patches/openfoam-4.1-cleanup.patch

BTW, please consider adding ChangeLog-style commit log, as per the
project’s conventions:

  https://guix.gnu.org/manual/devel/en/html_node/Submitting-Patches.html

(We can help you if needed.)

> -(define-public openfoam
> +(define-public openfoam-org

Maybe add:

  (define-public openfoam
    (deprecated-package "openfoam" openfoam-org))

Otherwise LGTM.

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[Ludovic Courtès]

reza <reza@housseini.me> skribis:

> +(define-public openfoam-com
> +  (package
> +    (inherit openfoam-org)
> +    (name "openfoam-com")
> +    (version "2212")
> +    (source (origin
> +              (method url-fetch)
> +
> +              (uri (string-append "https://develop.openfoam.com"
> +                    "/Development/openfoam/-/archive/OpenFOAM-v"
> +                    version
> +                    "/openfoam-OpenFOAM-v"
> +                    version
> +                    ".tar.gz"))
> +              (sha256
> +               (base32
> +                "0i9039hfz9gvgymkdjhjvvn5500zha3cpdbpqrzfrfi8lbz10is2"))
> +              (modules '((guix build utils)))
> +              (snippet '(begin
> +                          ;; patch shell paths
> +                          (substitute* (list "src/OSspecific/POSIX/POSIX.C"
> +                                             "wmake/src/Makefile"
> +                                             "wmake/makefiles/general"
> +                                             "wmake/makefiles/info")
> +                            (("/bin/sh")
> +                             which "sh"))))))
> +    (description
> +     "OpenFOAM is a free, open source CFD software released and developed by
> +OpenCFD Ltd since 2004.  It has a large user base across most areas of
> +engineering and science, from both commercial and academic organizations.

This is not OK:

  https://guix.gnu.org/manual/devel/en/html_node/Synopses-and-Descriptions.html

You can keep the description of ‘openfoam-org’, which is inherited.
However, please provide at least a different ‘synopsis’ to show how it
differs from ‘openfoam-org’.

Is the license the same for both?

Does “com” stand for “commercial”, and if so, what are the implications?

Thanks in advance,
Ludo’.

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[reza via Guix-patches via]

[-- Attachment #1: Type: text/plain, Size: 1586 bytes --]

> Great work, it’s good to have an OpenFoam update!

Yes this was a great hassle to finally compile, but I hope I made it 
future proof so there is not too much work for updates.
>> ---
>>   gnu/packages/check.scm | 34 ++++++++++++++++++++++++++++++++++
>>   1 file changed, 34 insertions(+)
> 
> Your mail user agent apparently added DOS-style line endings, which I
> think is the reason why <https://qa.guix.gnu.org/issue/62473> doesn’t
> have any info.
> 
> Could you try to use ‘git send-email’ in the future, to avoid that kind
> of issue?

This is strange, I use git send-email from a linux machine for the patches?

>> +(define-public ftest
>> +  (package
>> +    (name "ftest")
>> +    (version "bf75576064fce2e07f52cd63a3e410f12358728b")
> 
> That’s not a reasonable version string; see
> <https://guix.gnu.org/manual/devel/en/html_node/Version-Numbers.html>
> on how to derive version strings for Git checkouts.
> 
> Furthermore, when packaging a snapshot (as opposed to a tagged release),
> please add a short comment explaining why we’re not providing a release.

I'm not sure how to proceed here, there aren't any releases and it looks 
more like a small side project. I included it for completness but maybe 
we should drop it and skip the tests for utfcpp?

>> +    (build-system copy-build-system)
>> +    (native-inputs (list cmake-minimal))
> 
> Perhaps use ‘cmake-build-system’?

There is only a CMakeLists.txt file for the tests but not for the 
source, shall I provide one?

Thanks for looking into this!


[-- Attachment #2: OpenPGP_0xC375C6AF05125C52.asc --]
[-- Type: application/pgp-keys, Size: 15557 bytes --]

[-- Attachment #3: OpenPGP_signature --]
[-- Type: application/pgp-signature, Size: 499 bytes --]

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[reza via Guix-patches via]

[-- Attachment #1: Type: text/plain, Size: 514 bytes --]

> BTW, please consider adding ChangeLog-style commit log, as per the
> project’s conventions:
> 
>    https://guix.gnu.org/manual/devel/en/html_node/Submitting-Patches.html
> 
> (We can help you if needed.)

Will try to adhere to it in a new revision, feedback is definitely welcome.

>> -(define-public openfoam
>> +(define-public openfoam-org
> 
> Maybe add:
> 
>    (define-public openfoam
>      (deprecated-package "openfoam" openfoam-org))

Ok will add it to the updated patch revision


[-- Attachment #2: OpenPGP_0xC375C6AF05125C52.asc --]
[-- Type: application/pgp-keys, Size: 15557 bytes --]

[-- Attachment #3: OpenPGP_signature --]
[-- Type: application/pgp-signature, Size: 499 bytes --]

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[reza via Guix-patches via]

[-- Attachment #1: Type: text/plain, Size: 1062 bytes --]

> This is not OK:
> 
>    https://guix.gnu.org/manual/devel/en/html_node/Synopses-and-Descriptions.html
> 
> You can keep the description of ‘openfoam-org’, which is inherited.
> However, please provide at least a different ‘synopsis’ to show how it
> differs from ‘openfoam-org’.

Ok will change thy synopsis.

> Is the license the same for both?

They have the same license (GPL3.0)

> Does “com” stand for “commercial”, and if so, what are the implications?

"com" stands for the website "openfoam.com". The project forked at some 
point and now there are two almost identical code bases. openfoam-com 

which is maintained by a company has more rapid development in favor of 
stability while openfoam-org stays more conservative with code additions 
but being more stable therefore.

I don't know how to handle the almost identical builds of this two code 
bases, shall I make a function? There is also an issue with the version 
of openfoam-org getting used in the build of openfoam-com, maybe this is 
a bug?

[-- Attachment #2: OpenPGP_0xC375C6AF05125C52.asc --]
[-- Type: application/pgp-keys, Size: 15557 bytes --]

[-- Attachment #3: OpenPGP_signature --]
[-- Type: application/pgp-signature, Size: 499 bytes --]

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[Ludovic Courtès]

Hi,

reza <reza@housseini.me> skribis:

>>> +(define-public ftest
>>> +  (package
>>> +    (name "ftest")
>>> +    (version "bf75576064fce2e07f52cd63a3e410f12358728b")
>> 
>> That’s not a reasonable version string; see
>> <https://guix.gnu.org/manual/devel/en/html_node/Version-Numbers.html>
>> on how to derive version strings for Git checkouts.
>> 
>> Furthermore, when packaging a snapshot (as opposed to a tagged release),
>> please add a short comment explaining why we’re not providing a release.
>
> I'm not sure how to proceed here, there aren't any releases and it looks 
> more like a small side project. I included it for completness but maybe 
> we should drop it and skip the tests for utfcpp?

You can keep it; just add a comment with the explanation you wrote
above, and make sure the version string is built as show in the manual
page above.

>>> +    (build-system copy-build-system)
>>> +    (native-inputs (list cmake-minimal))
>> 
>> Perhaps use ‘cmake-build-system’?
>
> There is only a CMakeLists.txt file for the tests but not for the 
> source, shall I provide one?

Oh, weird.  Then just add a comment stating that and keep it this way.

Thanks,
Ludo’.

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[Ludovic Courtès]

Hi,

reza <reza@housseini.me> skribis:

>> Does “com” stand for “commercial”, and if so, what are the implications?
>
> "com" stands for the website "openfoam.com". The project forked at some 
> point and now there are two almost identical code bases. openfoam-com 
>
> which is maintained by a company has more rapid development in favor of 
> stability while openfoam-org stays more conservative with code additions 
> but being more stable therefore.

Interesting situation.  :-)

> I don't know how to handle the almost identical builds of this two code 
> bases, shall I make a function?

No, I think it’s fine to inherit like you did.

> There is also an issue with the version of openfoam-org getting used
> in the build of openfoam-com, maybe this is a bug?

Given your description above, it’s surprising that one depends on the
other.  If there is such a dependency, then it might be worth reporting
upstream as a bug or asking for clarifications.

Thanks for your replies!

Ludo’.

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[Ludovic Courtès]

Hi reza,

Sorry for taking so long to get back to you.

As I wrote in April, could you please resend with ‘git send-email’ or
somehow ensure your mail user agent doesn’t use DOS-style line endings?

  https://issues.guix.gnu.org/62473#11

Thanks in advance!

Ludo’.

[bug#62473] [PATCH v4 2/2] gnu: Add openfoam-com.

[reza via Guix-patches via]

* gnu/packages/simulation.scm (openfoam-com): New variable.
---
 gnu/packages/simulation.scm | 43 +++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/gnu/packages/simulation.scm b/gnu/packages/simulation.scm
index 303b7d8d5a..5f7a6b5078 100644
--- a/gnu/packages/simulation.scm
+++ b/gnu/packages/simulation.scm
@@ -396,6 +396,49 @@ (define-public openfoam-org
 (define-public openfoam
   (deprecated-package "openfoam" openfoam-org))
 
+(define-public openfoam-com
+  (package
+    (inherit openfoam-org)
+    (name "openfoam-com")
+    (version "2212")
+    (source (origin
+              (method url-fetch)
+              (uri (string-append "https://develop.openfoam.com"
+                                  "/Development/openfoam/-/archive/OpenFOAM-v"
+                                  version
+                                  "/openfoam-OpenFOAM-v"
+                                  version
+                                  ".tar.gz"))
+              (sha256
+               (base32
+                "0i9039hfz9gvgymkdjhjvvn5500zha3cpdbpqrzfrfi8lbz10is2"))
+              (modules '((guix build utils)))
+              (snippet `(begin
+                          (substitute* "etc/bashrc"
+                            ;; set same version as guix package
+			    (("^export WM_PROJECT_VERSION=.*$")
+			     (string-append "export WM_PROJECT_VERSION="
+					    ,version "\n")))
+                          ;; patch shell paths
+                          (substitute* (list "src/OSspecific/POSIX/POSIX.C"
+                                             "wmake/src/Makefile"
+                                             "wmake/makefiles/general"
+                                             "wmake/makefiles/info")
+                            (("/bin/sh")
+                             which "sh"))))))
+    (description
+     "OpenFOAM is a free, open source CFD software released and developed by
+OpenCFD Ltd since 2004.  It has a large user base across most areas of
+engineering and science, from both commercial and academic organizations.
+OpenFOAM has an extensive range of features to solve anything from complex
+fluid flows involving chemical reactions, turbulence and heat transfer, to
+acoustics, solid mechanics and electromagnetics.  See documentation OpenFOAM
+is professionally released every six months to include customer sponsored
+developments and contributions from the community - individual and group
+contributors, integrations (eg, from FOAM-extend and OpenFOAM Foundation Ltd)
+as well as governance guided activities.")
+    (home-page "https://www.openfoam.com")))
+
 (define-public open-simulation-interface
   (package
     (name "open-simulation-interface")
-- 
2.40.1

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[Ludovic Courtès]

Hi reza,

Finally pushed as 997b38badaee20a1c60411e5e599e260e47785ec.

I had to fix a number of things: line endings were still DOS-style,
requiring a manual edit, a module import was missing, there was a typo
“which "sh"” (without parens) that I changed to just "sh", there was a
circular dependency caused by engineering.scm that needed to be fixed,
and the synopsis of ‘openfoam-com’ had been left unchanged contrary to
what we had discussed.

So quite a lot of work.  Please pay more attention to review feedback
next time so we can more quickly process patches.

The good news is that this new version of OpenFoam is in now, yay!

Thanks,
Ludo’.

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[Hilton Chain via Guix-patches via]

Hi,

On Thu, 10 Aug 2023 15:48:12 +0800,
Ludovic Courtès wrote:
>
> I had to fix a number of things: line endings were still DOS-style,
> requiring a manual edit

Patchwork (QA page of the issue -> View series on Patchwork) seems to
handle this really well, I tried to download the series there and the
file uses LF for line endings.

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[reza via Guix-patches via]

[-- Attachment #1: Type: text/plain, Size: 805 bytes --]

Hi Ludo,

Thank you very much! Sorry for not following up on your review feedback, 
this was not intentional.
I asked on the mailing list about the circular dependency issue but got 
no reply and with my basic knowledge of guile I was basically lost.
Also the issue with line endings has me still scratching my head. I 
prepared the patch on a guix system with git send-mail I searched the 
internet for the issue but could not figure out why I had dos line endings?
The rest of the problems are really on my side and I apologize for it.

I'm in the process of preparing a follow up patch for openfoam, first to 
bump the version to 11 and second there is an issue with the naming 
convention of the share/OpenFOAM folder. I hope I can sort out the line 
ending issue, maybe you have an idea?

Best,
Reza

[-- Attachment #2: OpenPGP_0xC375C6AF05125C52.asc --]
[-- Type: application/pgp-keys, Size: 15557 bytes --]

[-- Attachment #3: OpenPGP_signature --]
[-- Type: application/pgp-signature, Size: 499 bytes --]

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[Hartmut Goebel]

This seems to be merged, see https://issues.guix.gnu.org/62473#29

  Can it be closed?

-- 
Regards
Hartmut Goebel

| Hartmut Goebel          | h.goebel@crazy-compilers.com               |
| www.crazy-compilers.com | compilers which you thought are impossible |

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[reza via Guix-patches via]

>   Can it be closed?

Yes this can be closed. There is already an update to version 11 here: 
https://issues.guix.gnu.org/66262

[bug#62473] [PATCH 0/4] OpenFoam update to version 10

[reza via Guix-patches via]

>   Can it be closed?

Yes this can be closed. There is already an update to version 11 here: 
https://issues.guix.gnu.org/66262