Difference between revisions of "Installation"
From OpenFOAMWiki
(New revamped structure for this page!) |
(Revised working and added a bit more description) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | '''The old instructions are still available here''': [[Installation/Installation (old monolithic version)]] | + | <big><big>'''The old instructions are still available here''': [[Installation/Installation (old monolithic version)]]</big></big> |
<hr> | <hr> | ||
| − | + | <br> | |
= Introduction = | = Introduction = | ||
| − | {{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. | + | 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. | ||
| − | |||
| − | 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: | + | 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]]. |
| + | |||
| + | 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__ | __TOC__ | ||
= Installing OpenFOAM = | = Installing OpenFOAM = | ||
| − | This is the tree of the categories and respective sub-categories about installing OpenFOAM: {{#categorytree:Installing OpenFOAM|mode=pages}} | + | This is the tree of the categories and respective sub-categories about installing OpenFOAM technology: {{#categorytree:Installing OpenFOAM|mode=pages|hideroot=on}} |
'''Notes''': | '''Notes''': | ||
| Line 20: | Line 23: | ||
* The tree list is automatically generated and probably is not complete, since it's constantly ongoing. | * The tree list is automatically generated and probably is not complete, since it's constantly ongoing. | ||
| − | + | ||
| + | = 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}} | ||
| + | |||
= Other Details = | = 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}} | + | 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}} |
= Outdated Instructions = | = Outdated Instructions = | ||
| − | This is the tree of outdated pages related to installing OpenFOAM and other third-party applications: {{#categorytree:Installing OpenFOAM - Outdated Instructions|mode=pages}} | + | 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}} |
= How to help = | = How to help = | ||
| Line 34: | Line 40: | ||
* [[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> | ||
| + | |||
| + | [[Category:Installing OpenFOAM]] | ||
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:
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:
- 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.
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:
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]]
