README 2.6 KB
Newer Older
1
Copyright (c) 2007-2008 Cisco Systems, Inc.  All rights reserved.
2 3 4 5 6 7 8
Copyright (C) 2018 OpenCFD Ltd.

Preamble
========

The openfoam-selector an OpenFOAM-specific adaptation of the
mpi-selector provided by Jeff Squyres and Cisco Systems.
9 10 11 12

Overview
========

13 14 15 16 17
openfoam-selector is simple tool to help manage multiple OPENFOAM
versions installed on a single host (or cluster).  It allows system
administrators to set a site-wide default OPENFOAM version, but also
allows users to selectively override that site-wide default with their
own choice of OPENFOAM version.
18 19 20 21 22

Both selections are optional and independent; system administrators
may choose not to set a site-wide default while users do choose to
their own default (and vice versa).

23
More information is contained in the openfoam-selector.1 man page.
24 25 26 27

Installation
============

28 29 30 31
openfoam-selector is installed with a traditional "configure" / "make"
combination common. The main option that you'll need for "configure"
is the --prefix option, which specifies the top directory where
openfoam-selector and its files are installed.
32 33 34 35 36 37 38 39 40 41

  shell$ ./configure --prefix=/where/to/install

Then run "make install" to install (you may need root permissions if
installing into restricted directories):

  shell# make install

This command will install the following files:

42
  $bindir/openfoam-selector
43 44
    --> $bindir defaults to "$prefix/bin", unless overridden on
        the "configure" command line
45
  $mandir/man1/openfoam-selector.1
46 47
    --> $mandir defaults to "$prefix/man", unless overridden on
        the "configure" command line
48 49 50
  $pkgdatadir/openfoam-selector.sh
  $pkgdatadir/openfoam-selector.csh
    --> $pkgdatadir defaults to "$prefix/share/openfoam-selector", unless
51 52 53 54 55 56 57 58
        overridden on the "configure" command line (RPMs will
        typically change this value -- YMMV).

The two files installed in $pkgdatadir are intended for site-wide
shell startup usage.  For example, on RedHat systems, they should be
copied to /etc/profile.d so that all shells will execute them upon
startup.

59 60
These last two files will examine both the site-wide and per user OPENFOAM
version selection, and if one is set, setup the shell's
61 62
environment for it.

63 64 65 66
The shell version also provides an "openfoam_select" function that can
be used directly from the user shell after changing versions and
without logging out.

67 68 69
Contact
=======

70 71
If you need assistance with openfoam-selector, first read the
openfoam-selector(1) man page; it contains more information than
72 73
listed here.

74 75
If that still does not answer your question, please post a gitlab issue
https://develop.openfoam.com/Community/feature-scripts
76

77
2018-12-03 OpenCFD Ltd.