Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
compilation [2013/04/24 17:22]
gag [Compilation]
compilation [2016/02/21 10:00] (current)
tzwinger [Compilation and Tests]
Line 1: Line 1:
-====== Compilation ====== +~~NOTOC~~ 
-The first step is to have a running Elmer on your computer. If it is not the casehave a look on the [[http://www.csc.fi/english/pages/elmer/sources|Elmer Compilation page]]. +====== Compilation and Tests ====== 
 +In these pages, you will find specific information regarding the [[compilation:compilationCmake|compilation]] of the Elmer/Ice solvers and user functions on Linux/*NIX systemsand explanation on the series of [[compilation:tests|tests]] that can be used to validate your installationThe compilation instructions above refer to the Cmake build system (introduced in February 2015)Outdated compilation instruction for the (now frozen) SVN version using the GNU autotools can be found from [[compilation:compilation|compilation with autotools]].
  
-As of revision 5955, Elmer/Ice is included in the SVN [[http://sourceforge.net/projects/elmerfem/|repository of Elmer]]. In the main trunk Elmer/Ice is to be found under ''trunk/elmerice''. Hence Elmer/Ice is retrieved with every checkout of the whole Elmer package. +For OS X users the easiest way to get Elmer installed is [[http://brew.sh|homebrew]]. There is a homebrew formula distributed via the [[https://github.com/ElmerCSC/homebrew-elmerfem|github]] repository and short description on how to use it (tested with El Capitanunder this [[compilation:homebrew|link]].
- +
-===== Download ===== +
-As mentioned above, Elmer/Ice can be retrieved through the whole Elmer package via [[http://sourceforge.net/projects/elmerfem/|SourceForge]]. Nevertheless, there is no real reason to always update/download the whole Elmer package. In order to get the Elmer/Ice part of the repository simply give the following SVN command in your shell +
-<code> +
-svn checkout svn://svn.code.sf.net/p/elmerfem/code/trunk/elmerice elmerice +
-</code> +
-NB: if you drop the ''elmerice'' at the end, you will get the whole Elmer source code, Elmer/Ice inclusive. +
- +
-===== Building Elmer/Ice ===== +
-The main prerequisites for building Elmer/Ice are: +
-  * A Fortran 90 compiler +
-  * (GNU) Make +
-  * The ''elmerice'' part of the repository +
-  * An existing Elmer installation +
-Elmer/Ice is simply built by ''make'' command from within the ''elmerice'' sub-directory. In order to define the installation directory, you have the option to directly define the variable ''$ELMERICE_HOME''. If you are running ''bash'', this would be done via: +
-<code> +
-export ELMERICE_HOME="/path/to/the/preferred/installation" +
-</code> +
-If this path does not exist, it will be created alongside the sub-directories ''lib'' and  ''include''. Nevertheless, it is **recommended that you define the variable ''ELMER_HOME'' instead** to point to the installation directory of Elmer and **leave ''ELMERICE_HOME'' undefined**. Then the installation directory points to ''$(ELMER_HOME)/share/elmersolver'', which then includes Elmer/Ice executables into the existing Elmer installation. +
- +
-Elmer/Ice is compiled by +
-<code> +
-make compile +
-</code> +
-and installed into the previously defined (or the recommended default) directory by +
-<code> +
-make install +
-</code> +
-Be aware that you have to have the rights to write into this directory. Hintif you need to use ''sudo'' rights to install, use the ''-E'' option in order to redirect the current environment (including the settings of ''$ELMERICE_HOME'' or ''$ELMER_HOME'') to the process. +
- +
-===== Usage ===== +
-To use the Elmer/Ice Solvers and User functions, simply modify your sif files to point on the //ElmerIceSolvers// and //ElmerIceUSF// object files: +
-<code> +
-Procedure =  File "ElmerIceSolvers" "NameSolver" +
-</code>  +
-where ''NameSolver'' is the name of the solver you want to execute.   +
- +
-===== License ===== +
-The complete tree ''elmerice'' is released under GPL 2 (or later), just like the rest of the code. The main difference of the ''elmerice'' branch with respect to the rest of Elmer is that for Elmer/Ice the intellectual property lies not with CSC, but with the community. In short that means that no non-GPL branch can be derived from anyone (including CSC). This also means, that Elmer/Ice code has to stay within the ''elmerice'' tree.+
compilation.1366824172.txt.gz · Last modified: 2013/04/24 17:22 by gag
CC Attribution-Share Alike 4.0 International
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0