Revision as of 02:40, 3 September 2009 (view source) Hoogs (Talk | contribs) (Trying to consolidate installation related stuff and make existing info more easily accessible, still some way to go) ← Older edit		Latest revision as of 12:11, 26 July 2015 (view source) Wyldckat (Talk | contribs) (Revised working and added a bit more description)
(55 intermediate revisions by 10 users not shown)
Line 1:		Line 1:
−	OpenFOAM is [http://www.opencfd.co.uk/openfoam/download.html available for download] as source code and binary files for linux and linux-like operating systems. An official Windows binary is not provided.	+	<big><big>'''The old instructions are still available here''': [[Installation/Installation (old monolithic version)]]</big></big>
		+	<hr>
		+	<br>
		+	= Introduction =
		+	This page aims to gather all possible instructions for installing as many versions, [[Forks_and_Variants|forks and variants]] of OpenFOAM technology and in as many Operating Systems as possible, for example:
		+	* {{OpenFOAM}} is [http://www.openfoam.org/download/ available for download] as source code and binary files for Linux and Linux-like operating systems (also known as [http://en.wikipedia.org/wiki/POSIX POSIX]-compliant systems), provided along with the official installation instructions. Currently there aren't any official Windows or Mac OS binaries provided by the {{OpenFOAM}} Foundation.
		+	* {{-Extend}} is [http://sourceforge.net/projects/openfoam-extend/files/ available for download] as source code and binary files for Linux and other operating systems.
−	=OpenFOAM=
−	==General Instructions==	+	This is where this [[Installation]] page steps in: provides a community based effort for documenting how to install OpenFOAM related technology (OpenFOAM, foam-extend, etc...) on any and all [http://en.wikipedia.org/wiki/Operating_system Operating Systems], along with more detailed instructions where possible. Keep in mind that this effort is constantly ongoing and may be slower than desired. If you want to help, please refer to the chapter [[#How to help|How to help]].
−	===OpenCFD git repository===	+	Since installing OpenFOAM related technology can be a rather extensive subject, specially due to the many OSes and respective versions, it has been divided into categories listed in the following Table of Contents:
		+	__TOC__
−	OpenCFD provide a repository using the [http://en.wikipedia.org/wiki/Git_(software) git distributed version control system].	+	= Installing OpenFOAM =
		+	This is the tree of the categories and respective sub-categories about installing OpenFOAM technology: {{#categorytree:Installing OpenFOAM|mode=pages|hideroot=on}}
−	{{VersionInfo}}{{Version1.6}}	+	'''Notes''':
−	====Unpacking====	+	* Click the '''+''' symbols for expanding the branches on the tree, the '''-''' symbols for collapsing expanded branches.
		+	* You'll find two types of branches:
		+	*# Branches that list sub-categories.
		+	*# Branches that list pages themselves.
		+	* The tree list is automatically generated and probably is not complete, since it's constantly ongoing.
−	To get the sources you will need to do the following
−	<pre>
−	cd ~/OpenFOAM/
−	git clone http://repo.or.cz/r/OpenFOAM-1.6.x.git/
−	cd OpenFOAM-1.6.x
−	git pull
−	</pre>
−	You will also need to install the ThirdParty source, from [http://www.opencfd.co.uk/openfoam/linux.html http://www.opencfd.co.uk/openfoam/linux.html], make sure you get the right version (ie 32 or 64 bit)	+	= Installing Third-Party software =
		+	This is the tree of the categories and respective sub-categories about installing Third-Party software which is meant for using with OpenFOAM: {{#categorytree:Installing Third-Party software|mode=pages|hideroot=on}}
−	To install this you need to unpack this file in the OpenFOAM directory (the code below assumes that the tar file is in <tt>~/OpenFOAM/</tt>	+	= Other Details =
		+	This is the tree of the pages with other details related to installing OpenFOAM and other third-party applications: {{#categorytree:Installing OpenFOAM - Other Details|mode=pages|hideroot=on}}
−	<pre>	+	= Outdated Instructions =
−	cd ~/OpenFOAM/	+	This is the tree of outdated pages related to installing OpenFOAM and other third-party applications: {{#categorytree:Installing OpenFOAM - Outdated Instructions|mode=pages|hideroot=on}}
−	tar -zxf ThirdParty-1.6.General.gtgz	+
−	</pre>	+
−	====Set-up====	+	= How to help =
−	Before compiling you will need to set up the openfoam environment. Firstly - set wmake to use the system compiler	+	The effort for this new page structure is being talked about on this thread: [http://www.cfd-online.com/Forums/openfoam-installation/102534-discussion-restructuring-installation-page-openfoamwiki-net.html &#91;Discussion&#93; Restructuring the Installation page at openfoamwiki.net] - this is where you can ask questions on how the structure for this section of the [http://openfoamwiki.net openfoamwiki.net] is kept.
−	in <tt>~/OpenFOAM/OpenFOAM-1.6.x/etc/settings.sh</tt> change the line (line no 98)	+	On each main OS page you should find instructions on how to add new pages and what is the structure to be respected. Said OS pages are:
−	<pre>	+	* [[Installation/Linux]]
−	compilerInstall=OpenFOAM	+	* [[Installation/Mac OS]]
−	</pre>	+	* [[Installation/Windows]]
−	to	+
−	<pre>	+
−	compilerInstall=System	+
−	</pre>	+
−	Next source the OF settings
−	<pre>
−	. ~/OpenFOAM/OpenFOAM-1.6.x/etc/bashrc
−	</pre>
−	Your session should now be set up to run OF-1.6 (but there won't be anything to run yet)	+	For the other 2 sets of category pages, here are the instructions for each one:
		+	<ul>
		+	<li>'''Other Details''': these pages are to be added directly in the [[Installation]] sub-pages section. <br>
		+	For example, for a page about the ''Shell Environment'', the page should be '''Installation/Shell Environment'''. <br>
		+	The category marker given in these pages should be:
		+	<pre>[[Category:Installing OpenFOAM - Other Details]]</pre></li>
		+	<li>'''Outdated Instructions ''': these pages are also to be added directly in the [[Installation]] sub-pages section. <br>
		+	For example, for a page about installing ''FoamX'', the page should be '''Installation/FoamX'''. <br>
		+	The category marker given in these pages should be:
		+	<pre>[[Category:Installing OpenFOAM - Outdated Instructions]]</pre></li>
		+	</ul>
−	===Compiling===	+	[[Category:Installing OpenFOAM]]
−		+
−	Next step is to compile OF.	+
−		+
−	Set the number of processors to use, in this case 4	+
−	<pre>	+
−	export WM_NCOMPPROCS=4	+
−	</pre>	+
−		+
−	Compile the ThirdParty stuff	+
−	<pre>	+
−	cd ~/OpenFOAM/	+
−	ln -s ThirdParty-1.6 ThirdParty-1.6.x	+
−	cd ThirdParty-1.6.x	+
−	./Allwmake	+
−	</pre>	+
−		+
−	Assuming you have no errors, we can now compile OpenFOAM	+
−	re-source the settings (to pick up newly created directories)	+
−	<pre>	+
−	cd ~/OpenFOAM/OpenFOAM-1.6.x	+
−	. etc/bashrc	+
−	</pre>	+
−		+
−	Then compile away	+
−	<pre>	+
−	./Allwmake	+
−	</pre>	+
−		+
−	When it finishes (hopefully) you should have a completely working installation.	+
−		+
−	===Compile OpenCFD release===	+
−	{{VersionInfo}}{{Version1.4}}	+
−		+
−	This is a step-by-step installation guide to OpenFOAM on 32 bit machines. It is highly focused on Linux-newbies, thus many steps might	+
−	look superfluous on more experienced users. The character ">" is used to signal that what follows on that specific line is to be typed in a command line.	+
−		+
−	- Make a directory for your OpenFOAM installation by typing:	+
−	> mkdir $HOME/OpenFOAM	+
−	> cd $HOME/OpenFOAM	+
−	> mkdir linux	+
−		+
−	- Download the following six archives from the opencfd-homepage to the $HOME/OpenFOAM directory:	+
−	> OpenFOAM-1.4.1.General.gtgz	+
−	> OpenFOAM-1.4.1.linuxGccDOpt.gtgz	+
−	> OpenFOAM-1.4.1.linuxGccSOpt.gtgz	+
−	> gcc-4.2.1.linux.tgz	+
−	> j2sdk1.4.2_05.linux.tgz	+
−	> paraview-2.4.4.linux.tgz	+
−		+
−	- Open a terminal and type:	+
−	> ls /usr/include/features.h	+
−	a) EITHER "/usr/include/features.h" is written to screen. Do not do any further.	+
−	b) OR "cannot access /usr/include/features.h: No such file or directory"	+
−	is written to screen. You need the build essentials to compile your own	+
−	boundary conditions, thus type the following in a terminal:	+
−	> aptitude install build-essential gcc	+
−		+
−	- Unpack the archives by typing the following command:	+
−	> cd $HOME/OpenFOAM	+
−	> tar -xzf OpenFOAM-1.4.1.General.gtgz	+
−	> tar -xzf OpenFOAM-1.4.1.linuxGCCDPOpt.gtgz	+
−	> tar -xzf OpenFOAM-1.4.1.linuxGCCSPOpt.gtgz	+
−	> tar -xzf gcc-4.2.1.linux.tgz linux/	+
−	> mv *.tgz linux/.	+
−	> cd linux	+
−	> tar -xzf gcc-4.2.1.linux.tgz	+
−	> tar -xzf j2sdk1.4.2_05.linux.tgz	+
−	> tar -xzf paraview-2.4.4.linux.tgz	+
−		+
−	- You need to set some environmental variables to be able to run OpenFOAM. This is done in the following way:	+
−		+
−	a) EITHER, if running bash or ksh (if in doubt type 'echo $SHELL'), do the	+
−	following:	+
−	> nano $HOME/.bashrc (this open a text-editor in your command window)	+
−	In the end of the file you type:	+
−	. $HOME/OpenFOAM/OpenFOAM-1.4.1/.OpenFOAM-1.4.1/bashrc	+
−	Press 'CTRL-X' to quit nano and agree to save changes.	+
−		+
−	a) OR, if running tcsh or csh (if in doubt type 'echo $SHELL'), do the	+
−	following:	+
−	> nano $HOME/.cshrc (this open a text-editor in your command window)	+
−	In the end of the file you type:	+
−	source $HOME/OpenFOAM/OpenFOAM-1.4.1/.OpenFOAM-1.4.1/cshrc	+
−	Press 'CTRL-X' to quit nano and agree to save changes.	+
−		+
−	- Open a new command-window. This will read $HOME/.bashrc and set all the necessary environmental variables. To check the installation do:	+
−	> cd ~/OpenFOAM/OpenFOAM-1.4.1/bin	+
−	> sh foamInstallationTest	+
−		+
−	- On single-machine setups, the installation test will probably produce a report which looks like this in the last couple of lines:	+
−		+
−	==============================================================================	+
−	Checking networking...	+
−		+
−	-------------------------------------------------------------------------------	+
−	Action                  Result                                      Crit	+
−	-------------------------------------------------------------------------------	+
−	Pinging_ngj-ubuntu      Successful                                  yes	+
−	Pinging_localHost        Successful                                  yes	+
−	Test_rsh:                Unsuccessful_connection_refused*            yes	+
−	Test_ssh:                Unsuccessful_connection_refused*            yes	+
−	FATAL ERROR: No remote shell available.	+
−	Foam1.4.1 enviroment requires either ssh and/or rsh.	+
−	Contact your system administrator.	+
−		+
−		+
−	-------------------------------------------------------------------------------	+
−		+
−	The system test has evoked 1 fatal error(s).	+
−		+
−	Critical systems ok.	+
−		+
−	Review the output for warning messages and consult	+
−	the installation guide for trouble shooting.	+
−	==============================================================================	+
−		+
−	This fatal error is due the test_rsh and test_ssh critiria, though they are	+
−	irrelevant on single-machine installations, i.e. only relevant for parallel-	+
−	processing on multiple machine.	+
−		+
−	- To setup the a working directory, follow step 6 in the ~/OpenFOAM/OpenFOAM-1.4.1/README file.	+
−		+
−	- You are now ready to begin working with OpenFOAM.	+
−		+
−	- Have fun:)	+
−		+
−	===OpenCFD binaries===	+
−		+
−	===OpenFOAM-dev subversion repository===	+
−		+
−	==System specific tips and experiences==	+
−		+
−	===OpenSuSE===	+
−	{{VersionInfo}}{{Version1.6}} [[User:Hoogs/Installation#1.6.x|1.6.x on 11.1, x86_64]] |	+
−		+
−	===Gentoo===	+
−	{{VersionInfo}}{{Version1.5}}	+
−		+
−	OpenFOAM and Paraview are now both in the main portage tree. For installation just type	+
−		+
−	<bash>	+
−	emerge openfoam-meta paraview	+
−	</bash>	+
−		+
−	In order to get OpenFOAM running, add the following line to your ~/.bashrc	+
−		+
−	alias startOF15="source /usr/lib/OpenFOAM/OpenFOAM-1.5/etc/bashrc"	+
−		+
−	And each time you want to use OpenFOAM just type '''''startOF15''''' in the active terminal.	+
−		+
−	===Ubuntu/Debian===	+
−		+
−	====Ubuntu Intrepid 8.1====	+
−	{{VersionInfo}}{{Version1.5}}	+
−		+
−	You have to add the following line to /etc/apt/sources.list either with your preferred text editor or package manager.	+
−		+
−	deb http://ppa.launchpad.net/cae-team/ppa/ubuntu intrepid main	+
−		+
−	Then you have to update your repository list, for example with	+
−		+
−	<bash>	+
−	sudo apt-get update	+
−	</bash>	+
−		+
−	After that you can install openfoam and paraview just by typing	+
−		+
−	<bash>	+
−	sudo apt-get install openfoam paraview	+
−	</bash>	+
−		+
−	In order to get OpenFOAM running, add the following line to your ~/.bashrc	+
−		+
−	alias startOF15="source /usr/lib/OpenFOAM-1.5/etc/bashrc"	+
−		+
−	And each time you want to use OpenFOAM just type '''''startOF15''''' in the active terminal.	+
−		+
−	====OpenFOAM-dev-1.5 under Ubuntu Intrepid 8.10====	+
−	{{VersionInfo}}{{Version1.5}}	+
−		+
−	In order to install the OpenFOAM-dev-1.5 version as debian package under Ubuntu Intrepid 8.10 you have to add the following line to /etc/apt/sources.list either with your preferred text editor or package manager.	+
−		+
−	deb http://ppa.launchpad.net/cae-team/ppa/ubuntu intrepid main	+
−		+
−	Then you have to update your repository list, for example with	+
−		+
−	<bash>	+
−	sudo apt-get update	+
−	</bash>	+
−		+
−	After that you can install the openfoam-dev-1.5 package just by typing	+
−		+
−	<bash>	+
−	sudo apt-get install openfoam-dev-1.5	+
−	</bash>	+
−		+
−	In order to get OpenFOAM running, add the following line to your ~/.bashrc	+
−		+
−	alias startOF15dev="source /usr/lib/OpenFOAM-1.5-dev/etc/bashrc"	+
−		+
−	And each time you want to use OpenFOAM just type '''''startOF15dev''''' in the active terminal.	+
−		+
−	====Debian====	+
−		+
−	You can check, if you can install the openfoam binaries, like with Ubuntu Intrepid 8.10. If this not applies, e.g. due to dependency problems, then you have to add the following line to the /etc/apt/sources.list	+
−		+
−	deb-src http://ppa.launchpad.net/cae-team/ppa/ubuntu intrepid main	+
−		+
−	Update you repository list	+
−		+
−	<bash>	+
−	sudo apt-get update	+
−	</bash>	+
−		+
−	After adding this line, you have to compile the debian source package of openfoam and/or paraview at your own by typing	+
−		+
−	<bash>	+
−	apt-get -b source openfoam	+
−	</bash>	+
−		+
−	and/or	+
−		+
−	<bash>	+
−	apt-get -b source openfoam-dev-1.5	+
−	</bash>	+
−		+
−	and/or	+
−		+
−	<bash>	+
−	apt-get -b source parafoam	+
−	</bash>	+
−		+
−	For further information about debian source packages, follow [http://www.debian.org/doc/manuals/apt-howto/ch-sourcehandling.en.html these guidlines].	+
−		+
−	In order to get OpenFOAM running, add the following line to your ~/.bashrc	+
−		+
−	alias startOF15="source /usr/lib/OpenFOAM-1.5/etc/bashrc"	+
−		+
−	And each time you want to use OpenFOAM just type '''''startOF15''''' in the active terminal.	+
−		+
−	=Paraview and paraFoam=	+
−		+
−	==Troubleshooting paraFoam==	+
−	{{VersionInfo}}{{Version1.5}}	+
−		+
−	If you have problems with paraFoam and the dev version you might have to recompile paraFoam (see http://www.opencfd.co.uk/openfoam/doc/README.html#Paraview). If paraFoam loads, but doesn't know which reader to use to display your OpenFoam results, recompiling the PV3FoamReader should suffice.	+
−		+
−	To do so, first make sure the environment variable $ParaView_INST_DIR contains the correct path (in my version of OF-1.5-dev there was a typo, a wrong "-"). If not, correct it in ~/OpenFOAM/OpenFOAM-1.5-dev/etc/apps/paraview3/bashrc and re-source ~/.bashrc. Then proceed with ./Allwclean and ./Allwmake in ~/OpenFOAM/OpenFOAM-1.5-dev/applications/utilities/postProcessing/graphics/PV3FoamReader.	+

---

Latest revision as of 12:11, 26 July 2015

The old instructions are still available here: Installation/Installation (old monolithic version)

---

1 Introduction

This page aims to gather all possible instructions for installing as many versions, forks and variants of OpenFOAM technology and in as many Operating Systems as possible, for example:

• OpenFOAM is available for download as source code and binary files for Linux and Linux-like operating systems (also known as POSIX-compliant systems), provided along with the official installation instructions. Currently there aren't any official Windows or Mac OS binaries provided by the OpenFOAM Foundation.
• the foam-extend project is available for download as source code and binary files for Linux and other operating systems.

This is where this Installation page steps in: provides a community based effort for documenting how to install OpenFOAM related technology (OpenFOAM, foam-extend, etc...) on any and all Operating Systems, along with more detailed instructions where possible. Keep in mind that this effort is constantly ongoing and may be slower than desired. If you want to help, please refer to the chapter How to help.

Since installing OpenFOAM related technology can be a rather extensive subject, specially due to the many OSes and respective versions, it has been divided into categories listed in the following Table of Contents:

2 Installing OpenFOAM

This is the tree of the categories and respective sub-categories about installing OpenFOAM technology:

Notes:

• Click the + symbols for expanding the branches on the tree, the - symbols for collapsing expanded branches.
• You'll find two types of branches:
  1. Branches that list sub-categories.
  2. Branches that list pages themselves.
• The tree list is automatically generated and probably is not complete, since it's constantly ongoing.

3 Installing Third-Party software

This is the tree of the categories and respective sub-categories about installing Third-Party software which is meant for using with OpenFOAM:

4 Other Details

This is the tree of the pages with other details related to installing OpenFOAM and other third-party applications:

5 Outdated Instructions

This is the tree of outdated pages related to installing OpenFOAM and other third-party applications:

6 How to help

The effort for this new page structure is being talked about on this thread: [Discussion] Restructuring the Installation page at openfoamwiki.net - this is where you can ask questions on how the structure for this section of the openfoamwiki.net is kept.

On each main OS page you should find instructions on how to add new pages and what is the structure to be respected. Said OS pages are:

• Installation/Linux
• Installation/Mac OS
• Installation/Windows

For the other 2 sets of category pages, here are the instructions for each one:

• Other Details: these pages are to be added directly in the Installation sub-pages section.
  For example, for a page about the Shell Environment, the page should be Installation/Shell Environment.
  The category marker given in these pages should be:

  [[Category:Installing OpenFOAM - Other Details]]

• Outdated Instructions : these pages are also to be added directly in the Installation sub-pages section.
  For example, for a page about installing FoamX, the page should be Installation/FoamX.
  The category marker given in these pages should be:

  [[Category:Installing OpenFOAM - Outdated Instructions]]