Difference between revisions of "Installation/swak4Foam/Downloading"

From OpenFOAMWiki
m (OpenFOAM 2.2.0 to 2.3.x)
(Updated instructions based on the latest details)
Line 119: Line 119:
 
</ol>
 
</ol>
  
== FOAM-Extend 3.0 and 3.1 ==
+
== FOAM-Extend 3.0 to 3.2 ==
 
'''Notes:'''
 
'''Notes:'''
* The downloading steps below have been tested after swak4Foam [[Contrib/swak4Foam#2014-01-24_-_Version:_0.3.0|version 0.3.0]] was released.
+
* The downloading steps below have been tested after swak4Foam [[Contrib/swak4Foam#2015-05-31 - Version: 0.3.2|version 0.3.2]] was released.
* FOAM-Extend 3.1 does provide its own swak4Foam built during the first installation, so the instructions below are most likely useful only as a reference or for updating.
+
* FOAM-Extend 3.1 and 3.2 versions do provide its own swak4Foam built during the first installation, so the instructions below are most likely useful only as a reference or for updating.
  
 
Installation steps:
 
Installation steps:
 
<ol>
 
<ol>
<li>First, go into a good working folder. For example, to go to the folder {{tt|$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION}}, run the following commands in a terminal:
+
<li>First, go into a good working folder. For example, to go to the folder {{tt|$HOME/foam/$USER-$WM_PROJECT_VERSION}}, run the following commands in a terminal:
 
<bash>mkdir -p $FOAM_RUN
 
<bash>mkdir -p $FOAM_RUN
 
cd "$HOME/foam/$USER-$WM_PROJECT_VERSION"</bash>
 
cd "$HOME/foam/$USER-$WM_PROJECT_VERSION"</bash>
Line 177: Line 177:
  
  
= swak4Foam development version for OpenFOAM 2.x and foam-extend 3.x =
+
= swak4Foam development version for OpenFOAM 2.x/3.x/dev and foam-extend 3.x =
'''Note:''' These instructions were written while swak4Foam [[Contrib/swak4Foam#2014-01-24_-_Version:_0.3.0|version 0.3.0]] was still the latest release and because 0.3.0 was not compatible with OpenFOAM 2.3. Nonetheless, as of swak4Foam [[Contrib/swak4Foam#2014-07-11_-_Version:_0.3.1|version 0.3.1]], it's compatible with all versions once again. Therefore, these instructions have been re-purposed for those who wish to try out the latest developments.
+
'''Note:''' These instructions were updated a while after  [[Contrib/swak4Foam#2015-05-31 - Version: 0.3.2|version 0.3.2]],  which isn't compatible with OpenFOAM 3.0.0/x.
  
 
Installation steps:
 
Installation steps:
Line 192: Line 192:
 
<li>From the main Mercurial development repository, using the {{tt|hg}} command, download from the repository and checkout the right branch:
 
<li>From the main Mercurial development repository, using the {{tt|hg}} command, download from the repository and checkout the right branch:
 
<bash>hg clone http://hg.code.sf.net/p/openfoam-extend/swak4Foam swak4Foam
 
<bash>hg clone http://hg.code.sf.net/p/openfoam-extend/swak4Foam swak4Foam
(cd swak4Foam && hg update port_2.0.x)</bash>
+
(cd swak4Foam && hg update default)</bash>
 
</li>
 
</li>
  
 
<li>Or manually download a snapshot from the Mercurial interface at Sourceforge.net:
 
<li>Or manually download a snapshot from the Mercurial interface at Sourceforge.net:
# Go to this page: [http://sourceforge.net/p/openfoam-extend/swak4Foam/ci/f537bda3865306a8110e8c7434911f352ce1ffcc/tarball Mercurial snapshot request for swak4Foam port_2.0.x commit f537bda3865306a8110e8c7434911f352ce1ffcc]
+
# Go to this page: [http://sourceforge.net/p/openfoam-extend/swak4Foam/ Mercurial repository for swak4Foam]
# Request a snapshot on that page.
+
# Request a snapshot on that page; in other words click on the link ''Download Snapshot''.
 
# Unpack the downloaded file and move the unpacked folder, into the folder indicated by this command: <bash>pwd</bash>
 
# Unpack the downloaded file and move the unpacked folder, into the folder indicated by this command: <bash>pwd</bash>
 
# Rename the folder to {{tt|swak4Foam}}.
 
# Rename the folder to {{tt|swak4Foam}}.
Line 203: Line 203:
  
 
<li>Or from a mirror Git repository ([https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev openfoam-extend-swak4Foam-dev]), using the {{tt|git}} command:
 
<li>Or from a mirror Git repository ([https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev openfoam-extend-swak4Foam-dev]), using the {{tt|git}} command:
{{ScrollableBox|<bash>git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev swak4Foam
+
{{ScrollableBox|<bash>git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev.git swak4Foam
cd swak4Foam
+
cd swak4Foam</bash>}}
git checkout port_2.0.x</bash>}}
+
 
</li>
 
</li>
  
 
<li>Or by downloading a snapshot in a ''GZipped Tarball'' format ({{tt|tar.gz}}) from the same Git mirror repository, either directly in the command line:
 
<li>Or by downloading a snapshot in a ''GZipped Tarball'' format ({{tt|tar.gz}}) from the same Git mirror repository, either directly in the command line:
{{ScrollableBox|<bash>wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/port_2.0.x.tar.gz" -O swak4Foam.tar.gz
+
{{ScrollableBox|<bash>wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/master.tar.gz" -O swak4Foam.tar.gz
 
tar -xf swak4Foam.tar.gz
 
tar -xf swak4Foam.tar.gz
mv openfoam-extend-swak4Foam-dev-port_2.0.x swak4Foam
+
mv openfoam-extend-swak4Foam-dev-master swak4Foam
 
</bash>}}
 
</bash>}}
 
Or manually:
 
Or manually:
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/port_2.0.x.tar.gz port_2.0.x.tar.gz]
+
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/master.tar.gz master.tar.gz]
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-swak4Foam-dev-port_2.0.x" into the folder indicated by this command: <bash>pwd</bash>
+
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-swak4Foam-dev-master" into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder: <bash>mv openfoam-extend-swak4Foam-dev-port_2.0.x swak4Foam</bash>
+
# Rename the folder: <bash>mv openfoam-extend-swak4Foam-dev-master swak4Foam</bash>
 
</li>
 
</li>
  
 
<li>Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
 
<li>Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
{{ScrollableBox|<bash>wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/port_2.0.x.zip" -O swak4Foam.zip
+
{{ScrollableBox|<bash>wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/master.zip" -O swak4Foam.zip
 
unzip swak4Foam.zip
 
unzip swak4Foam.zip
mv openfoam-extend-swak4Foam-dev-port_2.0.x swak4Foam
+
mv openfoam-extend-swak4Foam-dev-master swak4Foam
 
</bash>}}
 
</bash>}}
 
Or manually:
 
Or manually:
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/port_2.0.x.zip port_2.0.x.zip]
+
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/master.zip master.zip]
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-swak4Foam-dev-port_2.0.x" into the folder indicated by this command: <bash>pwd</bash>
+
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-swak4Foam-dev-master" into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder: <bash>mv openfoam-extend-swak4Foam-dev-port_2.0.x swak4Foam</bash>
+
# Rename the folder: <bash>mv openfoam-extend-swak4Foam-dev-master swak4Foam</bash>
 
</li>
 
</li>
  

Revision as of 19:13, 6 December 2015

1 Introduction

This page is dedicated to explaining how and which versions of swak4Foam to download and from where, depending on the OpenFOAM version you are using. Once you've successfully downloaded swak4Foam, go back to the instructions page you were following.

Note: If you do not yet feel comfortable using Linux, then perhaps you better first read the page Working with the Shell and train a bit with the shell/terminal environments, so you can have a better perception of the steps shown below.

Note to those who are willing to help:

  • Feel free to update this page whenever a new version of OpenFOAM or swak4Foam is made available and you've fully tested.
  • Installation instructions should be provided according to the indications given in the main Installation/swak4Foam page.


2 OpenFOAM

This chapter refers to the official version of OpenFOAM provided by the OpenFOAM Foundation.

2.1 OpenFOAM 2.2.0 to 2.4.x

Note: The downloading steps below have been tested after swak4Foam version 0.3.1 was released.

Installation steps:

  1. First, go into a good working folder. For example, to go to the folder $HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION, run the following commands in a terminal:
    mkdir -p $FOAM_RUN
    cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"
  2. Now, it all comes down to where you're able to download from one of the following locations (try each one, until you're able to download it):
    1. From the main SVN repository, using the svn command:
      svn checkout svn://svn.code.sf.net/p/openfoam-extend/svn/trunk/Breeder_2.0/libraries/swak4Foam/ swak4Foam
    2. Or from a mirror Git repository (openfoam-extend-Breeder2.0-libraries-swak4Foam), using the git command:
      git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam.git swak4Foam
    3. Or by downloading a snapshot in a GZipped Tarball format (tar.gz) from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/master.tar.gz" -O swak4Foam.tar.gz
      tar -xf swak4Foam.tar.gz
      mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam

      Or manually:

      1. Download this file: master.tar.gz
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-master" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam
    4. Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/master.zip" -O swak4Foam.zip
      unzip swak4Foam.zip
      mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam

      Or manually:

      1. Download this file: master.zip
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-master" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam
    5. Or manually download a snapshot from the SVN interface at Sourceforge.net:
      1. Go to this page: SVN snapshot request for swak4Foam 2.x series
      2. Request a snapshot on that page.
      3. Unpack the downloaded file and move the unpacked folder, into the folder indicated by this command:
        pwd
      4. Rename the folder to swak4Foam.

3 Extend Project variants of OpenFOAM

This chapter refers to the variants OpenFOAM provided by the Extend Project at FOAM-Extend.org.

3.1 OpenFOAM 1.6-ext

Note: The downloading steps below have been specifically coded for downloading swak4Foam version 0.2.4.

  1. First, go into a good working folder. For example, to go to the folder $HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION, run the following commands in a terminal:
    mkdir -p $FOAM_RUN
    cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"
  2. Now, it all comes down to where you're able to download from one of the following locations (try each one, until you're able to download it):
    1. From the main SVN repository, using the svn command:
      svn checkout svn://svn.code.sf.net/p/openfoam-extend/svn/trunk/Breeder_1.7/libraries/swak4Foam@1998 swak4Foam
    2. Or from a mirror Git repository (openfoam-extend-Breeder1.7-libraries-swak4Foam), using the git command:
      git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder1.7-libraries-swak4Foam.git swak4Foam
      (cd swak4Foam && git checkout 9ee3a04f9e -b 024)
    3. Or by downloading a snapshot in a GZipped Tarball format (tar.gz) from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder1.7-libraries-swak4Foam/archive/9ee3a04f9e22bb5c0c688223acb392e343589da1.tar.gz" -O swak4Foam.tar.gz
      tar -xf swak4Foam.tar.gz
      mv openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1 swak4Foam

      Or manually:

      1. Download this file: 9ee3a04f9e22bb5c0c688223acb392e343589da1.tar.gz
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1 swak4Foam
    4. Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder1.7-libraries-swak4Foam/archive/9ee3a04f9e22bb5c0c688223acb392e343589da1.zip" -O swak4Foam.zip
      unzip swak4Foam.zip
      mv openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1 swak4Foam

      Or manually:

      1. Download this file: 9ee3a04f9e22bb5c0c688223acb392e343589da1.zip
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1 swak4Foam

3.2 FOAM-Extend 3.0 to 3.2

Notes:

  • The downloading steps below have been tested after swak4Foam version 0.3.2 was released.
  • FOAM-Extend 3.1 and 3.2 versions do provide its own swak4Foam built during the first installation, so the instructions below are most likely useful only as a reference or for updating.

Installation steps:

  1. First, go into a good working folder. For example, to go to the folder $HOME/foam/$USER-$WM_PROJECT_VERSION, run the following commands in a terminal:
    mkdir -p $FOAM_RUN
    cd "$HOME/foam/$USER-$WM_PROJECT_VERSION"
  2. Now, it all comes down to where you're able to download from one of the following locations (try each one, until you're able to download it):
    1. From the main SVN repository, using the svn command:
      svn checkout svn://svn.code.sf.net/p/openfoam-extend/svn/trunk/Breeder_2.0/libraries/swak4Foam/ swak4Foam
    2. Or from a mirror Git repository (openfoam-extend-Breeder2.0-libraries-swak4Foam), using the git command:
      git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam.git swak4Foam
    3. Or by downloading a snapshot in a GZipped Tarball format (tar.gz) from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/master.tar.gz" -O swak4Foam.tar.gz
      tar -xf swak4Foam.tar.gz
      mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam

      Or manually:

      1. Download this file: master.tar.gz
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-master" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam
    4. Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/master.zip" -O swak4Foam.zip
      unzip swak4Foam.zip
      mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam

      Or manually:

      1. Download this file: master.zip
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-master" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam
    5. Or manually download a snapshot from the SVN interface at Sourceforge.net:
      1. Go to this page: SVN snapshot request for swak4Foam 2.x series
      2. Request a snapshot on that page.
      3. Unpack the downloaded file and move the unpacked folder, into the folder indicated by this command:
        pwd
      4. Rename the folder to swak4Foam.


4 swak4Foam development version for OpenFOAM 2.x/3.x/dev and foam-extend 3.x

Note: These instructions were updated a while after version 0.3.2, which isn't compatible with OpenFOAM 3.0.0/x.

Installation steps:

  1. First, go into a good working folder. For example, to go to the folder $HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION, run the following commands in a terminal:
    mkdir -p $FOAM_RUN
    cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"
  2. Now, it all comes down to where you're able to download from one of the following locations (try each one, until you're able to download it):
    1. From the main Mercurial development repository, using the hg command, download from the repository and checkout the right branch:
      hg clone http://hg.code.sf.net/p/openfoam-extend/swak4Foam swak4Foam
      (cd swak4Foam && hg update default)
    2. Or manually download a snapshot from the Mercurial interface at Sourceforge.net:
      1. Go to this page: Mercurial repository for swak4Foam
      2. Request a snapshot on that page; in other words click on the link Download Snapshot.
      3. Unpack the downloaded file and move the unpacked folder, into the folder indicated by this command:
        pwd
      4. Rename the folder to swak4Foam.
    3. Or from a mirror Git repository (openfoam-extend-swak4Foam-dev), using the git command:
      git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev.git swak4Foam
      cd swak4Foam
    4. Or by downloading a snapshot in a GZipped Tarball format (tar.gz) from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/master.tar.gz" -O swak4Foam.tar.gz
      tar -xf swak4Foam.tar.gz
      mv openfoam-extend-swak4Foam-dev-master swak4Foam

      Or manually:

      1. Download this file: master.tar.gz
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-swak4Foam-dev-master" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-swak4Foam-dev-master swak4Foam
    5. Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/master.zip" -O swak4Foam.zip
      unzip swak4Foam.zip
      mv openfoam-extend-swak4Foam-dev-master swak4Foam

      Or manually:

      1. Download this file: master.zip
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-swak4Foam-dev-master" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-swak4Foam-dev-master swak4Foam