Difference between revisions of "Doc:CAE"

From CAELinuxWiki
Jump to: navigation, search
 
m (Reverted edits by Lethuphuong89 (Talk); changed back to last version by Wikiadmin)
 
(21 intermediate revisions by 5 users not shown)
Line 1: Line 1:
== Getting started with CAELinux ==
+
== CAELinux Documentation: CAE softwares ==
J.Cugnoni, [www.caelinux.com www.caelinux.com], 2006
+
  
 +
=== Getting Started with CAELinux ===
 +
First of all, please read [[Doc:GettingStarted]] for a quick "getting started guide" ''(also included in CAELinux DVD)''.
  
=== Content: ===
+
For tutorials on how to use CAELinux in practice, see: [[Doc:CAETutorials]] and [http://www.caelinux.com/CMS/index.php?option=com_content&task=view&id=20&Itemid=2 CAELinux Tutorials]
# Welcome & Licence terms
+
# Introduction tutorial
+
# Softwares included in CAELinux Beta 3
+
# Installing & upgrading CAELinux
+
  
=== Welcome & Licence terms: ===
+
=== CAE Tutorials ===
 +
See [[Doc:CAETutorials]] contains an ever-growing set of tutorials related to CAD/FEA softwares included in CAELinux. If you want to learn how to solve real problems with CAELinux, this is the place to start with!
  
First of all, we would like to thank you for your interest in CAELinux
+
In the [[Contrib:Main]] section, you will also find a lot of usufull contributions, examples, benchmarks made by users of CAELinux.
which we hope will fullfill your needs in Computer Aided Engineering.
+
This Linux distribution is based on the excellent PCLinuxOS system and
+
includes an allways increasing number of open source modelling,
+
simulation & design softwares. Most of the content (99%) of
+
CAELinux is provided under the well known GPL  or  LGPL
+
 (Gnu Public Licence) which allows you to freely use and
+
redistribute these softwares but a small number of packages have their
+
own licencing terms (GraphiteOne for example). If you intend to use
+
this distribution for commercial work, it is your responsibility to
+
verify the licencing terms of the softwares that you are using. The
+
authors of the distribution are not responsible for these licencing
+
aspects and this distribution and all the included softwares are
+
provided without any warranty.
+
  
 +
=== CAE Software documentation ===
 +
CAElinux does not contain any "compiled" documentation for all the included softwares at the moment, but you should find most of the available documentation in the installation directory of the application (usually in ''/opt/MyApplication'').
  
=== Introduction tutorial ===
+
For more details see [[Doc:GettingStarted]]
For a very quick introduction to CAELinux capabilities, you should follow our <span style="font-weight: bold; font-style: italic;">Introduction Tutorial</span> here:
+
  
file:///opt/helpers/docs/tutorials/IntroductionTutorial1.pdf
+
'''Code-Aster Documentation'''
  
 +
Code-Aster is a powerfull french FE solver and is very well documented... but in French. To solve this issue, its documentation is being translated by generous contributors: see [[Proj:CodeAsterIntl]] for more details on on-going translation project.
  
=== Softwares included in CAELinux Beta 3 ===
+
At the moment, a second version of the English documentation is provided in CAELinux Beta 3b in ''/opt/helpers/docs/CodeAsterEnDoc/'' and a simple search engine can be runned with this command:
Here is a non exhaustive list of CAE software packages included in
+
python /opt/helpers/docs/CodeAsterEnDoc/SearchHelp.py
CAELinux as well as some key informations to get started. Some of the
+
softwares can be started from Desktop shortcuts or from the CAE start
+
menu, but most of the console based tools will require that you use our
+
special shell called 'Command line tools' (in CAE start menu).<br>
+
<br>
+
  
<table style="text-align: left; width: 100%;" border="1" cellpadding="2" cellspacing="2">
+
'''''Downloads'''''
  
 +
You can also download the English-HTML version documentation that has been automatically translated from official documentation (not 100% perfect, but understandable).
  
    <tr>
+
''Synopsis of documents in English, PDF Format, automatic translation !!''
  
      <td style="font-weight: bold; font-style: italic;">Software</td>
+
[[Media:Synopsis_desc.pdf]]
  
      <td style="font-weight: bold; font-style: italic;">Use</td>
+
[[Media:Synopsis_refer.pdf]]
  
      <td style="font-weight: bold; font-style: italic; width: 203px;">How to start</td>
+
[[Media:Synopsis_user.pdf]]
  
      <td style="font-weight: bold; font-style: italic; width: 134px;">Installation<br>
+
[[Media:Synopsis_valid.pdf]]
  
directory</td>
+
''Full documentation in English, HTML Format, automatic translation''
  
      <td style="font-weight: bold; font-style: italic;">Documentation</td>
+
[http://www.caelinux.org/wiki/downloads/AsterDocs-HTML-En.zip AsterDocs-HTML-En.zip]
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">Salome v3.2.1</td>
+
 
+
      <td>3D CAD,<br>
+
 
+
Meshing<br>
+
 
+
Post Processing</td>
+
 
+
      <td style="width: 203px;">Salome shortcut on desktop &amp; in CAE start menu</td>
+
 
+
      <td style="width: 134px;">/opt/salome</td>
+
 
+
      <td>- HTML doc accessible inside the application<br>
+
 
+
- Tutorials in /opt/helpers/docs</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">Code Aster STA8.3</td>
+
 
+
      <td>multiphysics FE analysis</td>
+
 
+
      <td style="width: 203px;">Create a new FE analysis from templates with New FE Study shortcut on Desktop or directly use the interface called ASTK&nbsp;</td>
+
 
+
      <td style="width: 134px;">/opt/aster</td>
+
 
+
      <td>- French documentation available from EFICAS.<br>
+
 
+
- English doc (automatic translations) in
+
/opt/helpers/docs/CodeAsterEnDoc, use&nbsp;SearchHelp.py from this
+
directory to search for keywords in the English docs.<br>
+
 
+
- Tutorials in /opt/helpers/docs<br>
+
 
+
- Examples in /opt/aster/STA8.3/astest</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">Impact</td>
+
 
+
      <td>explicit&nbsp;FE&nbsp; dynamics </td>
+
 
+
      <td style="width: 203px;">use shortcut in CAE start menu or start /opt/Impact.sh</td>
+
 
+
      <td style="width: 134px;">/opt/impact</td>
+
 
+
      <td>- Documentation available from the interface <br>
+
 
+
- Examples in installation directory</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">OpenFOAM<br>
+
 
+
v1.2</td>
+
 
+
      <td>multipurpose CFD oriented solvers</td>
+
 
+
      <td style="width: 203px;">use 'Command line tools' from CAE start menu or start FoamX interface from CAE menu or /opt/FoamX.sh</td>
+
 
+
      <td style="width: 134px;">/opt/OpenFOAM</td>
+
 
+
      <td>- Examples &amp; tutorials in /opt/OpenFOAM/OpenFOAM-1.2</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">Elmer v4.0</td>
+
 
+
      <td>multiphysics FE package</td>
+
 
+
      <td style="width: 203px;">use the shortcut from CAE start menu or start 'ElmerFront' from CAE 'Command line tools' console</td>
+
 
+
      <td style="width: 134px;">/opt/elmer</td>
+
 
+
      <td>- Documentation in /opt/elmer<br>
+
 
+
- Examples in /opt/elmer/ELMER4.0<br>
+
 
+
- mesh converter from Salome:&nbsp;<br>
+
 
+
/opt/helpers/unv2ElmerUNV.py</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">Calculix</td>
+
 
+
      <td>pre-post &amp; FE solver,&nbsp;Abaqus-like<br>
+
 
+
syntax</td>
+
 
+
      <td style="width: 203px;">from CAE 'Command line tools': start 'ccx' for Calculix solver &amp; 'cgx' for pre-post GUI</td>
+
 
+
      <td style="width: 134px;">/opt/calculix</td>
+
 
+
      <td>- Documentation in /opt/calculix/doc<br>
+
 
+
- Examples in /opt/calculix/example<br>
+
 
+
- mesh converter from Salome:<br>
+
 
+
/opt/helpers/unv2abaqus.py</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">GMSH</td>
+
 
+
      <td>Scriptable &amp; general purpose geometry modelling, meshing and post processing</td>
+
 
+
      <td style="width: 203px;">use shortcut on desktop &amp; start menu, or type 'gmsh' from 'Command line tools console'</td>
+
 
+
      <td style="width: 134px;">/opt/aster/outils/<br>
+
 
+
gmsh</td>
+
 
+
      <td>- tutorials &amp; demos in installation directory</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">Gerris flow solver</td>
+
 
+
      <td>2D / 3D&nbsp; CFD solvers based on automatic octree mesh refinement</td>
+
 
+
      <td style="width: 203px;">use from 'Command line tools' console:<br>
+
 
+
gerris2D, gerris3D, gfsview2D, gfsview3D etc..</td>
+
 
+
      <td style="width: 134px;">/opt/gerris</td>
+
 
+
      <td>- examples &amp; tests in installation directory</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">GraphiteOne</td>
+
 
+
      <td>2D &amp; 3D CAD system</td>
+
 
+
      <td style="width: 203px;">start 'graphiteone' from a console</td>
+
 
+
      <td style="width: 134px;">/usr/bin</td>
+
 
+
      <td>Free for personnal use, but not an 100% open-source package !!</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">BRL-CAD</td>
+
 
+
      <td>2D / 3D CAD</td>
+
 
+
      <td style="width: 203px;">start 'mged' from 'Command line tools' console</td>
+
 
+
      <td style="width: 134px;">/usr/brlcad</td>
+
 
+
      <td>- Documentation &amp; examples in installation directory</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">MBDyn</td>
+
 
+
      <td>multibody dynamics</td>
+
 
+
      <td style="width: 203px;">&nbsp;from 'Command line tools' console: start 'mbdyn'&nbsp;</td>
+
 
+
      <td style="width: 134px;">/opt/mbdyn</td>
+
 
+
      <td>- Documentation &amp; examples in installation directory<br>
+
 
+
- use 'mbdyn2easyanim.sh' &amp; 'EasyAnimx' for visualization</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">Tochnog</td>
+
 
+
      <td>statics &amp; dynamics FE solver</td>
+
 
+
      <td style="width: 203px;">&nbsp;from 'Command line tools' console: start 'tochnog'</td>
+
 
+
      <td style="width: 134px;">/opt/tochnog</td>
+
 
+
      <td>- Documentation &amp; examples in installation directory<br>
+
 
+
      </td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">OpenFlower</td>
+
 
+
      <td>3D&nbsp;CFD solver</td>
+
 
+
      <td style="width: 203px;">&nbsp;from 'Command line tools' console: start interface 'OpenFlowerGUI' <br>
+
 
+
or solver 'OpenFlower'</td>
+
 
+
      <td style="width: 134px;">/opt/openflower</td>
+
 
+
      <td>- Documentation &amp; examples in installation directory</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">GetDP</td>
+
 
+
      <td>general PDE solver</td>
+
 
+
      <td style="width: 203px;">&nbsp;from 'Command line tools' console: start solver 'getdp'</td>
+
 
+
      <td style="width: 134px;">/opt/getdp</td>
+
 
+
      <td>- Documentation &amp; examples in installation directory<br>
+
 
+
- can be started from GMSH</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">Octave</td>
+
 
+
      <td>MATLAB compatible mathematical programming</td>
+
 
+
      <td style="width: 203px;">from shortcuts on desktop or CAE menu, or type 'octave' in any console</td>
+
 
+
      <td style="width: 134px;">/usr/bin</td>
+
 
+
      <td>- Help available from within the octave shell, with the 'help' command</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">Scilab</td>
+
 
+
      <td>Matlab/Simulink-like mathematical programming environment</td>
+
 
+
      <td style="width: 203px;">from shortcuts on desktop or CAE menu, or type 'scilab' in any console</td>
+
 
+
      <td style="width: 134px;">/usr/bin</td>
+
 
+
      <td>- Help, examples, demos available from within the Scilab GUI</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">XMaxima</td>
+
 
+
      <td>Maple like symbolic computing environment</td>
+
 
+
      <td style="width: 203px;">from shortcuts on desktop or CAE menu, or type 'xmaxima' in any console</td>
+
 
+
      <td style="width: 134px;">/usr/bin</td>
+
 
+
      <td>- Help, examples, demos available from within the XMaxima GUI</td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">Paraview</td>
+
 
+
      <td>general purpose 3D visualization software</td>
+
 
+
      <td style="width: 203px;">from 'Command line tools' console: start '/opt/paraview.sh' &nbsp;or 'paraFoam' for OpenFOAM specific post pro</td>
+
 
+
      <td style="width: 134px;">/opt/OpenFOAM/linux/<br>
+
 
+
paraview-2.2.0</td>
+
 
+
      <td>- Help in OpenFOAM documentation </td>
+
 
+
    </tr>
+
 
+
    <tr>
+
 
+
      <td style="font-weight: bold; font-style: italic;">QCAD</td>
+
 
+
      <td>2D CAD program</td>
+
 
+
      <td style="width: 203px;">from Office/Graphs menu or type 'qcad' from any console</td>
+
 
+
      <td style="width: 134px;">/usr/bin</td>
+
 
+
      <td></td>
+
 
+
    </tr>
+
 
+
  <tr>
+
      <td style="font-weight: bold; font-style: italic;">other usefull tools</td>
+
      <td colspan="4" rowspan="1">Several usefull tools, documents and examples&nbsp;are provided in /opt/helpers directory:<br>
+
- CreateJob.py : GUI to create a Code-Aster FE analysis from template &amp; Salome MED mesh<br>
+
- Unv2X, unv2abaqus, ...: a set of python scripts to facilitate mesh
+
conversion from UNV (Salome for example) to other solvers like
+
Calculix, Elmer or OpenFOAM.<br>
+
- GenEnsightCase.py: a python script to generate an Ensight .case file from an Ensight ouput directory generated by Code-Aster.<br>
+
- /opt/helpers/docs/CodeAsterEnDoc/SearchHelp.py: a simple GUI to search for strings in the English Doc of Code Aster<br>
+
- /opt/helpers/docs/tutorials and /opt/helpers/docs/examples contains some interesting tutorials on combined use of Salome &amp; Code-Aster<br>
+
      </td>
+
    </tr>
+
 
+
</table>
+
 
+
<h3><br>
+
 
+
</h3>
+
 
+
=== Installing &amp; upgrading CAELinux ===
+
 
+
Thanks to the very simple PCLinuxOS installer, you can very quickly
+
turn your LiveDVD based CAELinux environment to a full featured hard
+
disk install which will let you customize and update your system as you
+
may want. We will not detail the installation steps here, but we highly
+
recommend that you read the documentation on the PCLinuxOS Wiki section
+
at [http://www.pclinuxos.com http://www.pclinuxos.com]. To install CAELinux Beta 3 on hard disk,
+
you will need at least 10Gb of free space on an ext3 partition and
+
preferably 1Gb on a Linux Swap partition (use PCLinuxOS disk
+
partitionning tool to resize or create your partitions &amp; BACKUP
+
your data FIRST). <br>
+
 
+
<br>
+
 
+
After installation, you will be able to customize your OS, install new
+
packages &amp; update your system (kernel, 3D drivers etc...) with the
+
very efficient PCLinuxOS Control Center (in Menu-&gt;Configuration).
+
From there, you will be able to configure all the aspects of the system
+
and directly install &amp; update softwares from Internet with the
+
Synaptics software package manager.<br>
+
 
+
<br>
+
 
+
For more information about the OS, drivers, kernel, etc.. please visit [http://www.pclinuxos.com http://www.pclinuxos.com]<br>
+
<br>
+
For any other question regarding CAELinux or one of the included software, you can visit our forums at [http://www.caelinux.com http://www.caelinux.com]
+

Latest revision as of 10:51, 28 December 2011

CAELinux Documentation: CAE softwares

Getting Started with CAELinux

First of all, please read Doc:GettingStarted for a quick "getting started guide" (also included in CAELinux DVD).

For tutorials on how to use CAELinux in practice, see: Doc:CAETutorials and CAELinux Tutorials

CAE Tutorials

See Doc:CAETutorials contains an ever-growing set of tutorials related to CAD/FEA softwares included in CAELinux. If you want to learn how to solve real problems with CAELinux, this is the place to start with!

In the Contrib:Main section, you will also find a lot of usufull contributions, examples, benchmarks made by users of CAELinux.

CAE Software documentation

CAElinux does not contain any "compiled" documentation for all the included softwares at the moment, but you should find most of the available documentation in the installation directory of the application (usually in /opt/MyApplication).

For more details see Doc:GettingStarted

Code-Aster Documentation

Code-Aster is a powerfull french FE solver and is very well documented... but in French. To solve this issue, its documentation is being translated by generous contributors: see Proj:CodeAsterIntl for more details on on-going translation project.

At the moment, a second version of the English documentation is provided in CAELinux Beta 3b in /opt/helpers/docs/CodeAsterEnDoc/ and a simple search engine can be runned with this command:

python /opt/helpers/docs/CodeAsterEnDoc/SearchHelp.py

Downloads

You can also download the English-HTML version documentation that has been automatically translated from official documentation (not 100% perfect, but understandable).

Synopsis of documents in English, PDF Format, automatic translation !!

Media:Synopsis_desc.pdf

Media:Synopsis_refer.pdf

Media:Synopsis_user.pdf

Media:Synopsis_valid.pdf

Full documentation in English, HTML Format, automatic translation

AsterDocs-HTML-En.zip