[jackhill/guix/guix.git] / gnu / packages / simulation.scm

;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2017 Paul Garlick <pgarlick@tourbillion-technology.com>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu packages simulation)
  #:use-module (gnu packages)
  #:use-module (gnu packages base)
  #:use-module (gnu packages bash)
  #:use-module (gnu packages bison)
  #:use-module (gnu packages boost)
  #:use-module (gnu packages compression)
  #:use-module (gnu packages flex)
  #:use-module (gnu packages gettext)
  #:use-module (gnu packages gcc)
  #:use-module (gnu packages gl)
  #:use-module (gnu packages graphics)
  #:use-module (gnu packages gtk)
  #:use-module (gnu packages linux)
  #:use-module (gnu packages m4)
  #:use-module (gnu packages maths)
  #:use-module (gnu packages mpi)
  #:use-module (gnu packages multiprecision)
  #:use-module (gnu packages ncurses)
  #:use-module (gnu packages readline)
  #:use-module (gnu packages tls)
  #:use-module (gnu packages version-control)
  #:use-module (gnu packages xml)
  #:use-module (gnu packages xorg)
  #:use-module (guix download)
  #:use-module (guix build utils)
  #:use-module (guix build-system gnu)
  #:use-module ((guix licenses) #:prefix license:)
  #:use-module (guix packages)
  #:use-module (guix utils)
  #:use-module (ice-9 ftw)
  #:use-module (ice-9 regex)
  #:use-module (srfi srfi-1))

(define-public openfoam
  (package
    (name "openfoam")
    (version "4.1")
    (source
     (origin
       (method url-fetch)
       (uri (string-append
             "http://dl.openfoam.org/source/"
             (string-map (lambda (x) (if (eq? x #\.) #\- x)) version)))
       (file-name (string-append name "-" version ".tar.gz"))
       (sha256
        (base32 "0cgxh4h2hf50qbvvdg5miwc2nympb0nrv3md96vb3gbs9vk8vq9d"))
       (patches (search-patches "openfoam-4.1-cleanup.patch"))))
    (build-system gnu-build-system)
    (inputs
     `(("boost" ,boost)
       ("cgal" ,cgal)
       ("flex" ,flex)
       ("git" ,git)
       ("gmp" ,gmp)
       ("libxt" ,libxt)
       ("metis" ,metis)
       ("mpfr" ,mpfr)
       ("ncurses" ,ncurses)
       ("readline" ,readline)
       ("scotch" ,pt-scotch32)
       ("zlib" ,zlib)))
    (native-inputs
     `(("bison" ,bison)))
    (propagated-inputs
     `(("gzip" ,gzip)
       ("gnuplot" ,gnuplot)
       ("openmpi" ,openmpi)))
    (outputs '("debug"                  ;~60MB
               "out"))
    (arguments
     `( ;; Executable files and shared libraries are located in the 'platforms'
       ;; subdirectory.
       #:strip-directories (list (string-append
                                  "lib/OpenFOAM-" ,version
                                  "/platforms/linux64GccDPInt32Opt/bin")
                                 (string-append
                                  "lib/OpenFOAM-" ,version
                                  "/platforms/linux64GccDPInt32Opt/lib"))
       #:tests? #f                                ; no tests to run

       #:modules ((ice-9 ftw)
                  (ice-9 regex)
                  (guix build gnu-build-system)
                  (guix build utils))

       #:phases (modify-phases %standard-phases
                  (add-after 'unpack 'rename-build-directory
                    (lambda _
                      (chdir "..")
                      ;; Use 'OpenFOAM-version' convention to match the file
                      ;; name expectations in the build phase.
                      (let ((unpack-dir (string-append
                                         (getcwd) "/"
                                         (list-ref (scandir (getcwd) (lambda (name)
                                                                       (string-match "^OpenFOAM" name))) 0)))
                            (build-dir (string-append
                                        (getcwd) "/OpenFOAM-" ,version)))
                        (rename-file unpack-dir build-dir) ; rename build directory
                        (chdir (basename build-dir))) ; move to build directory
                      #t))
                  (delete 'configure)             ; no configure phase
                  (replace 'build
                    (lambda _
                      (let ((libraries '("boost" "cgal" "gmp" "metis" "mpfr" "scotch")))
                        ;; set variables to define store paths
                        (for-each (lambda (library)
                                    (setenv (string-append
                                             (string-upcase library) "_ROOT")
                                            (assoc-ref %build-inputs library))) libraries))
                      ;; set variables to define package versions
                      (setenv "SCOTCHVERSION" ,(package-version scotch))
                      (setenv "METISVERSION" ,(package-version metis))
                      ;; set variable to pass extra 'rpath' arguments to linker
                      (setenv "LDFLAGS"
                              (string-append
                               "-Wl,"
                               "-rpath=" %output "/lib/OpenFOAM-" ,version
                               "/platforms/linux64GccDPInt32Opt/lib,"
                               "-rpath=" %output "/lib/OpenFOAM-" ,version
                               "/platforms/linux64GccDPInt32Opt/lib/dummy"))
                      ;; compile OpenFOAM libraries and applications
                      (zero? (system (format #f
                                             "source ./etc/bashrc && ./Allwmake -j~a"
                                             (parallel-job-count))))))
                  (add-after 'build 'update-configuration-files
                    (lambda _
                      ;; record store paths and package versions in
                      ;; configuration files
                      (substitute* "etc/config.sh/CGAL"
                        (("$BOOST_ROOT") (getenv "BOOST_ROOT")))
                      (substitute* "etc/config.sh/CGAL"
                        (("$CGAL_ROOT") (getenv "CGAL_ROOT")))
                      (substitute* "etc/config.sh/metis"
                        (("$METIS_ROOT") (getenv "METIS_ROOT")))
                      (substitute* "etc/config.sh/metis"
                        (("$METISVERSION") (getenv "METISVERSION")))
                      (substitute* "etc/config.sh/scotch"
                        (("$SCOTCH_ROOT") (getenv "SCOTCH_ROOT")))
                      (substitute* "etc/config.sh/scotch"
                        (("$SCOTCHVERSION") (getenv "SCOTCHVERSION")))
                      (substitute* "etc/config.sh/settings"
                        (("$GMP_ROOT") (getenv "GMP_ROOT")))
                      (substitute* "etc/config.sh/settings"
                        (("$MPFR_ROOT") (getenv "MPFR_ROOT")))
                      ;; reset lockDir variable to refer to write-enabled
                      ;; directory
                      (substitute* "wmake/wmake"
                        (("        lockDir=.*$")
                         "        lockDir=$HOME/.$WM_PROJECT/.wmake\n"))
                      (substitute* "wmake/wmakeScheduler"
                        (("lockDir=.*$")
                         "lockDir=$HOME/.$WM_PROJECT/.wmake\n"))
                      (substitute* "wmake/wmakeSchedulerUptime"
                        (("lockDir=.*$")
                         "lockDir=$HOME/.$WM_PROJECT/.wmake\n"))
                      #t))
                  (add-after 'build 'cleanup
                    ;; Avoid unncessary, voluminous object and dep files.
                    (lambda _
                      (delete-file-recursively
                       "platforms/linux64GccDPInt32Opt/src")
                      (delete-file-recursively
                       "platforms/linux64GccDPInt32OptSYSTEMOPENMPI")
                      (for-each delete-file (find-files "." "\\.o$"))
                      #t))
                  (replace 'install
                    (lambda _
                      ;; use 'OpenFOAM-version' convention
                      (let ((install-dir (string-append
                                          %output "/lib/OpenFOAM-" ,version)))
                        (mkdir-p install-dir)     ; create install directory
                        ;; move contents of build directory to install directory
                        (copy-recursively "." install-dir))))
                  (add-after 'install 'add-symbolic-link
                    (lambda _
                      ;; add symbolic link for standard 'bin' directory
                      (symlink
                       (string-append "./lib/OpenFOAM-" ,version
                                      "/platforms/linux64GccDPInt32Opt/bin")
                       (string-append %output "/bin"))
                      #t)))))
    ;; Note:
    ;;  Tutorial files are installed read-only in /gnu/store.
    ;;  To allow write permissions on files copied from the store a
    ;;  'chmod' step is needed before running the applications.  For
    ;;  example, from a user's login:
    ;;  $ source $GUIX_PROFILE/lib/OpenFOAM-4.1/etc/bashrc
    ;;  $ mkdir -p $FOAM_RUN
    ;;  $ cd $FOAM_RUN
    ;;  $ cp -r $FOAM_TUTORIALS/incompressible/simpleFoam/pitzDaily .
    ;;  $ cd pitzDaily
    ;;  $ chmod -R u+w .
    ;;  $ blockMesh
    (synopsis "Framework for numerical simulation of fluid flow")
    (description "OpenFOAM provides a set of solvers and methods for tackling
problems in the field of Computational Fluid Dynamics (CFD).  It is written in
C++.  Governing equations such as the Navier-Stokes equations can be solved in
integral form.  Physical processes such as phase change, droplet transport and
chemical reaction can be modelled.  Numerical methods are included to deal with
sharp gradients, such as those encountered in flows with shock waves and flows
with gas/liquid interfaces.  Large problems may be split into smaller, connected
problems for efficient solution on parallel systems.")
    (license license:gpl3+)
    (home-page "https://openfoam.org")))
Commit	Line	Data
8f21aa22 PG	1	;;; GNU Guix --- Functional package management for GNU
	2	;;; Copyright © 2017 Paul Garlick <pgarlick@tourbillion-technology.com>
	3	;;;
	4	;;; This file is part of GNU Guix.
	5	;;;
	6	;;; GNU Guix is free software; you can redistribute it and/or modify it
	7	;;; under the terms of the GNU General Public License as published by
	8	;;; the Free Software Foundation; either version 3 of the License, or (at
	9	;;; your option) any later version.
	10	;;;
	11	;;; GNU Guix is distributed in the hope that it will be useful, but
	12	;;; WITHOUT ANY WARRANTY; without even the implied warranty of
	13	;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	;;; GNU General Public License for more details.
	15	;;;
	16	;;; You should have received a copy of the GNU General Public License
	17	;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
	18
	19	(define-module (gnu packages simulation)
	20	#:use-module (gnu packages)
	21	#:use-module (gnu packages base)
	22	#:use-module (gnu packages bash)
	23	#:use-module (gnu packages bison)
	24	#:use-module (gnu packages boost)
	25	#:use-module (gnu packages compression)
	26	#:use-module (gnu packages flex)
	27	#:use-module (gnu packages gettext)
	28	#:use-module (gnu packages gcc)
	29	#:use-module (gnu packages gl)
	30	#:use-module (gnu packages graphics)
	31	#:use-module (gnu packages gtk)
	32	#:use-module (gnu packages linux)
	33	#:use-module (gnu packages m4)
	34	#:use-module (gnu packages maths)
	35	#:use-module (gnu packages mpi)
	36	#:use-module (gnu packages multiprecision)
	37	#:use-module (gnu packages ncurses)
	38	#:use-module (gnu packages readline)
	39	#:use-module (gnu packages tls)
	40	#:use-module (gnu packages version-control)
	41	#:use-module (gnu packages xml)
	42	#:use-module (gnu packages xorg)
	43	#:use-module (guix download)
	44	#:use-module (guix build utils)
	45	#:use-module (guix build-system gnu)
	46	#:use-module ((guix licenses) #:prefix license:)
	47	#:use-module (guix packages)
	48	#:use-module (guix utils)
	49	#:use-module (ice-9 ftw)
	50	#:use-module (ice-9 regex)
	51	#:use-module (srfi srfi-1))
	52
	53	(define-public openfoam
	54	(package
	55	(name "openfoam")
	56	(version "4.1")
	57	(source
	58	(origin
	59	(method url-fetch)
	60	(uri (string-append
	61	"http://dl.openfoam.org/source/"
	62	(string-map (lambda (x) (if (eq? x #\.) #\- x)) version)))
	63	(file-name (string-append name "-" version ".tar.gz"))
	64	(sha256
65	(base32 "0cgxh4h2hf50qbvvdg5miwc2nympb0nrv3md96vb3gbs9vk8vq9d"))
66	(patches (search-patches "openfoam-4.1-cleanup.patch"))))
67	(build-system gnu-build-system)
68	(inputs
69	`(("boost" ,boost)
70	("cgal" ,cgal)
71	("flex" ,flex)
72	("git" ,git)
73	("gmp" ,gmp)
74	("libxt" ,libxt)
75	("metis" ,metis)
76	("mpfr" ,mpfr)
77	("ncurses" ,ncurses)
78	("readline" ,readline)
79	("scotch" ,pt-scotch32)
80	("zlib" ,zlib)))
81	(native-inputs
82	`(("bison" ,bison)))
83	(propagated-inputs
84	`(("gzip" ,gzip)
85	("gnuplot" ,gnuplot)
86	("openmpi" ,openmpi)))
f1de0e37 DL	87	(outputs '("debug" ;~60MB
f1de0e37 DL	88	"out"))
8f21aa22 PG	89	(arguments
	90	`( ;; Executable files and shared libraries are located in the 'platforms'
	91	;; subdirectory.
	92	#:strip-directories (list (string-append
	93	"lib/OpenFOAM-" ,version
	94	"/platforms/linux64GccDPInt32Opt/bin")
	95	(string-append
	96	"lib/OpenFOAM-" ,version
	97	"/platforms/linux64GccDPInt32Opt/lib"))
	98	#:tests? #f ; no tests to run
	99
	100	#:modules ((ice-9 ftw)
	101	(ice-9 regex)
	102	(guix build gnu-build-system)
	103	(guix build utils))
	104
	105	#:phases (modify-phases %standard-phases
	106	(add-after 'unpack 'rename-build-directory
	107	(lambda _
	108	(chdir "..")
	109	;; Use 'OpenFOAM-version' convention to match the file
	110	;; name expectations in the build phase.
	111	(let ((unpack-dir (string-append
	112	(getcwd) "/"
	113	(list-ref (scandir (getcwd) (lambda (name)
	114	(string-match "^OpenFOAM" name))) 0)))
	115	(build-dir (string-append
	116	(getcwd) "/OpenFOAM-" ,version)))
	117	(rename-file unpack-dir build-dir) ; rename build directory
	118	(chdir (basename build-dir))) ; move to build directory
	119	#t))
	120	(delete 'configure) ; no configure phase
	121	(replace 'build
	122	(lambda _
	123	(let ((libraries '("boost" "cgal" "gmp" "metis" "mpfr" "scotch")))
	124	;; set variables to define store paths
	125	(for-each (lambda (library)
	126	(setenv (string-append
	127	(string-upcase library) "_ROOT")
	128	(assoc-ref %build-inputs library))) libraries))
	129	;; set variables to define package versions
	130	(setenv "SCOTCHVERSION" ,(package-version scotch))
	131	(setenv "METISVERSION" ,(package-version metis))
	132	;; set variable to pass extra 'rpath' arguments to linker
	133	(setenv "LDFLAGS"
	134	(string-append
	135	"-Wl,"
	136	"-rpath=" %output "/lib/OpenFOAM-" ,version
	137	"/platforms/linux64GccDPInt32Opt/lib,"
	138	"-rpath=" %output "/lib/OpenFOAM-" ,version
	139	"/platforms/linux64GccDPInt32Opt/lib/dummy"))
	140	;; compile OpenFOAM libraries and applications
	141	(zero? (system (format #f
	142	"source ./etc/bashrc && ./Allwmake -j~a"
	143	(parallel-job-count))))))
	144	(add-after 'build 'update-configuration-files
	145	(lambda _
	146	;; record store paths and package versions in
	147	;; configuration files
	148	(substitute* "etc/config.sh/CGAL"
	149	(("$BOOST_ROOT") (getenv "BOOST_ROOT")))
	150	(substitute* "etc/config.sh/CGAL"
	151	(("$CGAL_ROOT") (getenv "CGAL_ROOT")))
	152	(substitute* "etc/config.sh/metis"
153	(("$METIS_ROOT") (getenv "METIS_ROOT")))
154	(substitute* "etc/config.sh/metis"
155	(("$METISVERSION") (getenv "METISVERSION")))
156	(substitute* "etc/config.sh/scotch"
157	(("$SCOTCH_ROOT") (getenv "SCOTCH_ROOT")))
158	(substitute* "etc/config.sh/scotch"
159	(("$SCOTCHVERSION") (getenv "SCOTCHVERSION")))
160	(substitute* "etc/config.sh/settings"
161	(("$GMP_ROOT") (getenv "GMP_ROOT")))
162	(substitute* "etc/config.sh/settings"
163	(("$MPFR_ROOT") (getenv "MPFR_ROOT")))
164	;; reset lockDir variable to refer to write-enabled
165	;; directory
166	(substitute* "wmake/wmake"
167	((" lockDir=.*$")
168	" lockDir=$HOME/.$WM_PROJECT/.wmake\n"))
169	(substitute* "wmake/wmakeScheduler"
170	(("lockDir=.*$")
171	"lockDir=$HOME/.$WM_PROJECT/.wmake\n"))
172	(substitute* "wmake/wmakeSchedulerUptime"
173	(("lockDir=.*$")
174	"lockDir=$HOME/.$WM_PROJECT/.wmake\n"))
175	#t))
f1de0e37 DL	176	(add-after 'build 'cleanup
	177	;; Avoid unncessary, voluminous object and dep files.
	178	(lambda _
	179	(delete-file-recursively
	180	"platforms/linux64GccDPInt32Opt/src")
	181	(delete-file-recursively
	182	"platforms/linux64GccDPInt32OptSYSTEMOPENMPI")
	183	(for-each delete-file (find-files "." "\\.o$"))
	184	#t))
8f21aa22 PG	185	(replace 'install
	186	(lambda _
	187	;; use 'OpenFOAM-version' convention
	188	(let ((install-dir (string-append
	189	%output "/lib/OpenFOAM-" ,version)))
	190	(mkdir-p install-dir) ; create install directory
	191	;; move contents of build directory to install directory
	192	(copy-recursively "." install-dir))))
	193	(add-after 'install 'add-symbolic-link
	194	(lambda _
	195	;; add symbolic link for standard 'bin' directory
	196	(symlink
	197	(string-append "./lib/OpenFOAM-" ,version
	198	"/platforms/linux64GccDPInt32Opt/bin")
	199	(string-append %output "/bin"))
	200	#t)))))
	201	;; Note:
	202	;; Tutorial files are installed read-only in /gnu/store.
	203	;; To allow write permissions on files copied from the store a
	204	;; 'chmod' step is needed before running the applications. For
	205	;; example, from a user's login:
	206	;; $ source $GUIX_PROFILE/lib/OpenFOAM-4.1/etc/bashrc
	207	;; $ mkdir -p $FOAM_RUN
	208	;; $ cd $FOAM_RUN
a836e9f5 PG	209	;; $ cp -r $FOAM_TUTORIALS/incompressible/simpleFoam/pitzDaily .
a836e9f5 PG	210	;; $ cd pitzDaily
8f21aa22 PG	211	;; $ chmod -R u+w .
	212	;; $ blockMesh
	213	(synopsis "Framework for numerical simulation of fluid flow")
	214	(description "OpenFOAM provides a set of solvers and methods for tackling
	215	problems in the field of Computational Fluid Dynamics (CFD). It is written in
	216	C++. Governing equations such as the Navier-Stokes equations can be solved in
	217	integral form. Physical processes such as phase change, droplet transport and
	218	chemical reaction can be modelled. Numerical methods are included to deal with
	219	sharp gradients, such as those encountered in flows with shock waves and flows
	220	with gas/liquid interfaces. Large problems may be split into smaller, connected
b6598237	221	problems for efficient solution on parallel systems.")
8f21aa22 PG	222	(license license:gpl3+)
8f21aa22 PG	223	(home-page "https://openfoam.org")))