Difference between revisions of "Basic Installation Steps"

From OpenFOAMWiki
Redirect page
(Troubleshooting paraFoam: - forgot to resource the bashrc)
(Consolidating)
 
Line 1: Line 1:
== Installation under gentoo linux ==
+
#REDIRECT [[Installation]]
 
+
{{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.
+
 
+
== Installation under debian or ubuntu linux ==
+
 
+
{{VersionInfo}}{{Version1.5}}
+
 
+
=== 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 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 ===
+
 
+
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 or other Ubuntu versions ===
+
 
+
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.
+
 
+
== Manual Installation ==
+
 
+
{{VersionInfo}}{{Version1.4}}
+
 
+
This is a step-by-step installation guide to OpenFOAM on 32bit 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:)
+
 
+
=== 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 03:42, 3 September 2009