Difference between revisions of "OpenFOAM/C3/Installing-and-Running-PyFoam/English"

From Script | Spoken-Tutorial
Jump to: navigation, search
 
Line 49: Line 49:
  
  
−
- '''Ubuntu''' Linux Operating system '''14.04'''
+
- '''Ubuntu Linux''' Operating system '''14.04'''
  
  
Line 70: Line 70:
  
  
−
- If not please watch the Linux tutorial on this website
+
- If not, please go through the '''Linux''' tutorial series on this website
−
 
+
−
 
+
−
 
+
  
 
|-
 
|-
Line 89: Line 86:
  
 
-It is Designed to make working with '''OpenFOAM''' easier
 
-It is Designed to make working with '''OpenFOAM''' easier
−
 
−
 
−
 
  
 
|-
 
|-
Line 103: Line 97:
  
  
−
- '''iteratively''' running '''simulations'''
+
* '''iteratively''' running '''simulations'''
  
 +
* automate data collection
  
−
- automate data collection
+
* parametrically modify case files and
  
 +
* many other such useful activities.
  
−
- parametrically modify case files and
 
  
 +
Note that '''PyFoam '''works over '''OpenFOAM'''
  
−
- many other such useful activities.
 
  
−
 
+
So, we need to always have an installation of '''OpenFOAM''' in our computer.
−
Note that :
+
−
 
+
−
 
+
−
- '''PyFoam '''works over '''OpenFOAM'''
+
−
 
+
−
 
+
−
- Thus we need to always have an installation of '''OpenFOAM''' in our computer  
+
  
 
|-
 
|-
Line 131: Line 119:
  
  
−
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| First we check if our installation of OpenFOAM has been done properly  
+
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| First we check if our installation of '''OpenFOAM''' has been done properly.
  
  
−
Open a '''terminal''', and type '''icoFoam -help'''
+
Open the '''terminal''', and type '''icoFoam -help'''
  
  
Line 156: Line 144:
  
 
type in terminal
 
type in terminal
−
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we will install the necessary prerequisites for PyFoam such as
+
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we will install the necessary prerequisites for '''PyFoam''', such as
  
−
-Python, Pip, Numpy and Gnuplot  
+
*'''Python, Pip, Numpy''' and '''Gnuplot'''
  
 +
using the '''terminal'''.
  
−
using the terminal.
 
  
 +
First we type -
  
−
First we type
 
  
 +
'''sudo apt-get install python-dev '''and press '''Enter'''.
  
−
'''sudo apt-get install python-dev '''and press enter
 
  
 +
After this, type
  
−
Then, type
+
'''sudo apt-get install python-pip '''and press '''Enter'''.
−
 
+
−
'''sudo apt-get install python-pip '''and press enter
+
  
  
Line 182: Line 169:
 
Then, type  
 
Then, type  
  
−
'''sudo apt-get install gnuplot gnuplot-x11 '''and press enter
+
'''sudo apt-get install gnuplot gnuplot-x11 '''and press '''Enter'''.
  
  
−
With this we are done with installing the pre-requisites
+
With this we are done with installing the pre-requisites.
  
 
|-
 
|-
Line 194: Line 181:
  
 
Open terminal  
 
Open terminal  
−
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we will installing '''PyFoam''' using pip
+
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we will installing '''PyFoam''' using '''pip'''.
  
  
−
Open the terminal and Type: '''pip install PyFoam '''
+
Open the '''terminal''' and type: '''pip install PyFoam '''
  
 
|-
 
|-
Line 218: Line 205:
  
 
install PyFoam
 
install PyFoam
−
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We can also installing '''PyFoam''' from '''source'''
+
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| We can also install '''PyFoam''' from '''source'''
  
  
−
To do so, Open the browser and in the URL window type
+
To do so, open the browser and in the URL window, type
  
−
[http://www.pypi.com/ www.pypi.com]  
+
'''[http://www.pypi.com/ www.pypi.com]'''
  
  
 
Search for '''PyFoam '''
 
Search for '''PyFoam '''
 +
  
 
Download '''PyFoam-0.6.5.tar.xz'''  
 
Download '''PyFoam-0.6.5.tar.xz'''  
  
  
−
In the terminal go to downloads folder  
+
In the '''terminal''', go to '''Downloads folder'''.
  
  
Line 237: Line 225:
  
  
−
Type cd name of the folder '''PyFoam-0.6.5'''
+
Type '''cd''' followed by the name of the folder '''PyFoam-0.6.5'''
  
  
−
aftet this type '''sudo''' '''python setup.py''' '''install'''  
+
After this, type '''sudo python setup.py' space install'''  
  
 
|-
 
|-
Line 259: Line 247:
  
 
check the message
 
check the message
−
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we have Check if PyFoam is detecting  
+
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now we have check if '''PyFoam''' is detecting  
  
−
OpenFoam and working correctly.  
+
'''OpenFoam''' and working properly.  
  
  
−
Switch to terminal again
+
Switch to '''terminal''' again.
  
  
Line 270: Line 258:
  
  
−
'''import PyFoam'''
+
Type '''import PyFoam'''
  
  
−
'''from PyFoam.FoamInformation '''
+
'''import PyFoam dot FoamInformation '''
  
  
−
'''print from PyFoam.FoamInformation.foamTutorials()'''
+
Then type '''print PyFoam dot FoamInformation dot foamTutorials''' followed by open-close brackets.
  
  
−
This Should print directory of OpenFOAM Tutorials.  
+
This should print the directory of '''OpenFOAM Tutorials'''.  
  
−
 
−
Now let us summarise
 
  
 
|-
 
|-
−
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide  
+
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Summary Slide
  
 +
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Now let us summarise.
  
−
Forum to answer questions
 
−
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your timed queries in this forum
 
  
 +
In this tutorial, we learnt about '''PyFoam'''.
  
 +
We also learnt to
  
 +
*check the installation of '''OpenFoam'''
 +
 +
* install '''PyFoam''' using '''pip'''
 +
 +
* install '''PyFoam''' using '''sources'''
 +
 +
* and check if '''PyFoam''' is working
 +
 +
|-
 +
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:none;padding:0.097cm;"| Show Slide
 +
 +
 +
Forum to answer questions
 +
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your timed queries in this forum.
  
 
|-
 
|-
Line 299: Line 300:
  
 
Forum to answer questions
 
Forum to answer questions
−
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your general queries on OpenFOAM in this forum
+
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| Please post your general queries on OpenFOAM in this forum.
  
 
|-
 
|-
Line 306: Line 307:
  
 
Textbook Companion  
 
Textbook Companion  
−
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The '''FOSSEE '''team coordinates the TBC project
+
| style="border-top:none;border-bottom:0.05pt solid #000000;border-left:0.05pt solid #000000;border-right:0.05pt solid #000000;padding:0.097cm;"| The '''FOSSEE '''team coordinates the TBC project.
  
 
|-
 
|-

Latest revision as of 11:29, 9 May 2016

Title of script: Installing and Running PyFoam


Script : Anmol Sahoo, Rahul Joshi


Narration : Rahul Joshi


Keywords: OpenFOAM, PyFoam, CFD, Spoken Tutorial, Python


Visual Cue
Narration
Show Slide : Title Hello and welcome to the spoken tutorial on installing and running PyFoam
Show Slide : Learning Objectives In this tutorial, we will learn how to Install and check PyFoam and the required steps for the same.


- What is PyFoam


- Checking installation of OpenFOAM


- Installing Python, Numpy and Gnuplot


- Install PyFoam using pip


- Install PyFoam using sources


- Check if PyFoam is working

Show Slide :

System Requirement

To record this tutorial I am using


- Ubuntu Linux Operating system 14.04


- OpenFOAM version 2.3.0


- Note that PyFoam will also work with OpenFoam v1.6+ and above

Show Slide :

Pre-requisite

To practice this tutorial, the user should have


- Basic knowledge of Linux terminal commands


- Experience with running and analyzing OpenFOAM cases


- If not, please go through the Linux tutorial series on this website

Show Slide :

Introduction to PyFoam

What is PyFoam?


-PyFoam is a collection of Python libraries and utilities


-It can be used to manipulate OpenFOAM simulations and


-It is Designed to make working with OpenFOAM easier

Show Slide :

Introduction to PyFoam


PyFoam can be also be used for


  • iteratively running simulations
  • automate data collection
  • parametrically modify case files and
  • many other such useful activities.


Note that PyFoam works over OpenFOAM


So, we need to always have an installation of OpenFOAM in our computer.

Show Slide: Checking OpenFOAM


Open terminal


First we check if our installation of OpenFOAM has been done properly.


Open the terminal, and type icoFoam -help


You should get the details of icoFoam and OpenFOAM version and help text

Show Slide : Installing Pre-Requisites


Open Terminal


type in terminal


type in terminal


type in terminal


type in terminal

Now we will install the necessary prerequisites for PyFoam, such as
  • Python, Pip, Numpy and Gnuplot

using the terminal.


First we type -


sudo apt-get install python-dev and press Enter.


After this, type

sudo apt-get install python-pip and press Enter.


Then, type

pip install Numpy


Then, type

sudo apt-get install gnuplot gnuplot-x11 and press Enter.


With this we are done with installing the pre-requisites.

Show Slide :

Install PyFoam


Open terminal

Now we will installing PyFoam using pip.


Open the terminal and type: pip install PyFoam

Show Slide :

Installing PyFoam


Open browser


Download PyFoam


Open terminal : go to Downloads folder


Untar the files


install PyFoam

We can also install PyFoam from source


To do so, open the browser and in the URL window, type

www.pypi.com


Search for PyFoam


Download PyFoam-0.6.5.tar.xz


In the terminal, go to Downloads folder.


Type tar -xvf PyFoam-0.6.5.tar.xz


Type cd followed by the name of the folder PyFoam-0.6.5


After this, type sudo python setup.py' space install

Show Slides: Checking PyFoam


Open Terminal : To Check PyFoam working


type in terminal


type in terminal


type in terminal


check the message

Now we have check if PyFoam is detecting

OpenFoam and working properly.


Switch to terminal again.


Type python


Type import PyFoam


import PyFoam dot FoamInformation


Then type print PyFoam dot FoamInformation dot foamTutorials followed by open-close brackets.


This should print the directory of OpenFOAM Tutorials.


Summary Slide Now let us summarise.


In this tutorial, we learnt about PyFoam.

We also learnt to

  • check the installation of OpenFoam
  • install PyFoam using pip
  • install PyFoam using sources
  • and check if PyFoam is working
Show Slide


Forum to answer questions

Please post your timed queries in this forum.
Show Slide


Forum to answer questions

Please post your general queries on OpenFOAM in this forum.
Show Slide


Textbook Companion

The FOSSEE team coordinates the TBC project.
Show Slide

Acknowledgement


The Spoken Tutorial project is funded by NMEICT, MHRD, Govt. of India


For more details , visit this website.

Thank You The script is prepared by Anmol Sahoo and this is Rahul Joshi from IIT Bombay signing off. Thanks for watching

Contributors and Content Editors

Nancyvarkey, Rahuljoshi

Retrieved from "https://script.spoken-tutorial.org/index.php?title=OpenFOAM/C3/Installing-and-Running-PyFoam/English&oldid=26618"