Difference between revisions of "Installation"

From OpenFOAMWiki
(I've hidden the base categories in the category trees, to avoid additional confusion...)
(How to help: Added instructions on how to add pages for the last two categories)
Line 34: Line 34:
 
* [[Installation/Mac OS]]
 
* [[Installation/Mac OS]]
 
* [[Installation/Windows]]
 
* [[Installation/Windows]]
 +
 +
 +
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>

Revision as of 08:23, 19 August 2012

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


1 Introduction

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.

This is where this Installation page steps in: provides a community based effort for documenting how to install OpenFOAM 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 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:


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 Other Details

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


4 Outdated Instructions

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


5 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:


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]]