[m_ridzon]

Reading through OpenFoam Technology Primer, it seems that "pyFoamPlotWatcher" can be used to monitor residuals during an OpenFoam solution. With the simple cavity model, I issued:

icoFoam > log1 &
pyFoamPlotWatcher.py log1

The plotter does nothing though and returns this:

If 'pyFoamPlotWatcher.py' is not a typo you can use command-not-found to lookup the package that contains it, like this:
cnf pyFoamPlotWatcher.py

Can anybody help me figure out how to use pyFoamPlotWatcher? I'm using OpenFoam 2.4.0, on OpenSuse 13.2, Gnome 3.14.1.

Thanks in advance,
M Ridzon

[student666]

Try to type a "dot" like log.run or log.1

Sent from my ASUS_X008D using CFD Online Forum mobile app

[wouter]

hello m_ridzon,
it looks to me that you did not install pyFoam and/or swak4foam.

hope this helps
Wouter

[m_ridzon]

Originally Posted by student666

Try to type a "dot" like log.run or log.1

Unfortunately, adding a dot didn't help.

Originally Posted by wouter

hello m_ridzon,
it looks to me that you did not install pyFoam and/or swak4foam.

hope this helps
Wouter

I suspect it may need installed, but I'm still fairly new to Linux. Can you tell how to check if it's installed? And if I find it not installed, how would I then install it? I'm using OpenFoam 2.4.0, on OpenSuse 13.2, Gnome 3.14.1.

Thanks in advance,
M Ridzon

[khedar]

run following on command line

pyFoamPlotWatcher.py --version

It should print something like

pyFoamPlotWatcher.py 0.6.6

The version number might be different though. For installation check out this link.

https://openfoamwiki.net/index.php/C...m#Installation

[m_ridzon]

Originally Posted by khedar

run following on command line

pyFoamPlotWatcher.py --version

It should print something like

pyFoamPlotWatcher.py 0.6.6

The version number might be different though. For installation check out this link.

https://openfoamwiki.net/index.php/C...m#Installation

It did not print what you showed. Instead, it printed:

If 'pyFoamPlotWatcher.py' is not a typo you can use command-not-found to lookup the package that contains it, like this:
    cnf pyFoamPlotWatcher.py

So I then proceeded to follow your link and install pyFoamPlotWatcher. It didn't seem to work for me though. I issued:

sudo pip install PyFoam

At the end it gave me errors, but I'm not sure what they mean. I attached the LOG file to this forum post. Does anybody have any ideas what other steps I need to take?

Thanks again!
M Ridzon

[Persia]

Maybe you need to install OpenBLAS first. Follow this link for installation instructions: http://www.openblas.net/

[kera]

It seems that some of the packages required for the installation is not installed on your system.

As per your error, and I quote:

SystemError: Cannot compile 'Python.h'. Perhaps you need to install python-dev|python-devel.

you need to install python-dev and python-setuptools, also mentioned here.

hope this helps!

Regards,
Ricky

Originally Posted by m_ridzon

It did not print what you showed. Instead, it printed:

If 'pyFoamPlotWatcher.py' is not a typo you can use command-not-found to lookup the package that contains it, like this:
    cnf pyFoamPlotWatcher.py

So I then proceeded to follow your link and install pyFoamPlotWatcher. It didn't seem to work for me though. I issued:

sudo pip install PyFoam

At the end it gave me errors, but I'm not sure what they mean. I attached the LOG file to this forum post. Does anybody have any ideas what other steps I need to take?

Thanks again!
M Ridzon

[m_ridzon]

I noticed this error also:

Originally Posted by kera

It seems that some of the packages required for the installation is not installed on your system.

As per your error, and I quote:



you need to install python-dev and python-setuptools, also mentioned here.

So yes, I tried to install the python-dev and python-setuptools. I issued:

Matt@LinuxBox:~> sudo zypper install python-devel
root's password:
Loading repository data...
Warning: Repository 'openSUSE-13.2-Update' appears to be outdated. Consider using a different mirror or server.
Warning: Repository 'openSUSE-13.2-Update-Non-Oss' appears to be outdated. Consider using a different mirror or server.
Reading installed packages...
'python-devel' is already installed.
No update candidate for 'python-devel-2.7.12-3.1.x86_64'. The highest available version is already installed.
Resolving package dependencies...

Nothing to do.

Matt@LinuxBox:~> sudo zypper install python-setuptools
Loading repository data...
Warning: Repository 'openSUSE-13.2-Update' appears to be outdated. Consider using a different mirror or server.
Warning: Repository 'openSUSE-13.2-Update-Non-Oss' appears to be outdated. Consider using a different mirror or server.
Reading installed packages...
Resolving package dependencies...

The following NEW package is going to be installed:
  python-setuptools

1 new package to install.
Overall download size: 310.4 KiB. Already cached: 0 B  After the operation,
additional 1.3 MiB will be used.
Continue? [y/n/? shows all options] (y): y
Retrieving package python-setuptools-5.4.1-2.1.4.noarch
                                           (1/1), 310.4 KiB (  1.3 MiB unpacked)
Retrieving: python-setuptools-5.4.1-2.1.4.noarch.rpm .....................[done]
Checking for file conflicts: .............................................[done]
(1/1) Installing: python-setuptools-5.4.1-2.1.4 ..........................[done]

I also installed OpenBLAS per this reply:

Originally Posted by Persia

Maybe you need to install OpenBLAS first. Follow this link for installation instructions: http://www.openblas.net/

The OpenBLAS installation appeared to go smoothly after downloading it and issuing "make".

I again issued:

sudo pip install PyFoam

I get compile errors again though, which are shown in my new attachment.

Any thoughts?

Thanks again!
M Ridzon

[m_ridzon]

As I continue to try and debug this, I issued this:

pyFoamVersion.py

and got this:

Machine info: Linux | LinuxBox | 3.16.7-21-desktop | #1 SMP PREEMPT Tue Apr 14 07:11:37 UTC 2015 (93c1539) | x86_64 | x86_64

Python version: 3.4.5 (default, Jul 03 2016, 13:55:08) [GCC]

Python executable: /usr/bin/python3

Python 3 is supported with PyFoam
PYTHONPATH is not set

Location of this utility: /usr/bin/pyFoamVersion.py

 PyFoam WARNING on line 201 of file /usr/lib/python3.4/site-packages/PyFoam/FoamInformation.py : Basedir /home/Matt/foam for fork extend does not exist or is not a directory 
Version 4.0 (reported as number 4.0 )Fork openfoam of the installed 3 versions:
openfoam-2.3.1 : /home/Matt/OpenFOAM/OpenFOAM-2.3.1
openfoam-2.4.0 : /home/Matt/OpenFOAM/OpenFOAM-2.4.0
  openfoam-4.0 : /home/Matt/OpenFOAM/OpenFOAM-4.0

pyFoam-Version: 0.6.7

Path where PyFoam was found (PyFoam.__path__) is ['/usr/lib/python3.4/site-packages/PyFoam']

Configuration search path: [('file', '/etc/pyFoam/pyfoamrc'), ('directory', '/etc/pyFoam/pyfoamrc.d'), ('file', '/home/Matt/.pyFoam/pyfoamrc'), ('directory', '/home/Matt/.pyFoam/pyfoamrc.d')]
Configuration files (used): []

Installed libraries:
cython                         :  No      Not used. Maybe will by used later to spped up parts of PyFoam 
cProfile                       :  Yes 
docutils                       :  No      Not necessary. Needed for RestructuredText to HTML conversion 
Gnuplot                        :  No      Not a problem. Version from ThirdParty is used 
hotshot                        :  No      Not a problem. Can't profile using this library 
line_profiler                  :  No      Not a problem. Can't profile using this library 
ipdb                           :  No      Not necessary. Only makes debugging more comfortable 
IPython                        :  No      Not necessary. But the interactive shell may be more comfortable 
matplotlib                     :  No      Only Gnuplot-plotting possible 
mercurial                      :  No      Not a problem. Used for experimental case handling 
pytest                         :  No      Only needed for running the unit-tests (developers only) 
numpy                          :  No      Plotting and data comparison won't work 
numpypy                        :  No      This workaround for PyPy does not work 
openpyxl                       :  No      Not a problem. Only used for exporting pandas-data to Excel-files (advanced). If xlsxwriter is installed it will handle this (xlsxwriter is recommended anyway) 
xlsxwriter                     :  No      Not a problem. Only used for exporting pandas-data to XLSX-files (advanced). If openpyxl is installed then this module can handle that 
pandas                         :  No      Not a problem. Only used for handling of advanced data-handling 
ply                            :  No      Not a problem. Version from ThirdParty is used 
profile                        :  Yes 
psyco                          :  No      Not a problem. Acceleration not possible 
PyQt4                          :  No      Only some experimental GUI-stuff relies on this 
PyQt4.Qwt5                     :  No      Only an alternate plotting back-end 
scipy                          :  No      Not yet used. Possibly use signal-fitting etc 
Tkinter                        :  No      Not a problem. Used for the old version of DisplayBlockmesh and some matplotlib-implementations 
twisted                        :  No      Not yet used. Possibly reimplement MetaServer with it 
vtk                            :  No      Not a problem. Only used for some utilities 
xlwt                           :  No      Not a problem. Only used for exporting pandas-data to Excel-files 
xlrd                           :  No      Not a problem. Only used for importing Excel-files to pandas-data 
requests                       :  No      Not a problem. Currently only needed for the blink(1)-support 
PyFoam.ThirdParty.ply.yacc     :  Yes      version: 3.9 
PyFoam.ThirdParty.Gnuplot      :  No      This is our own. If it is not found we've got problems 
PyFoam.ThirdParty.tqdm         :  Yes      version: 4.8.4 
PyFoam.ThirdParty.IPy          :  Syntax Error      This is our own. If it is not found we've got problems 
PyFoam.ThirdParty.pyratemp     :  Yes      version: 0.2.0 
PyFoam.ThirdParty.six          :  Yes      version: 1.10.0 
PyFoam.ThirdParty.winhacks     :  Yes 

Library locations
cProfile                       : /usr/lib64/python3.4/cProfile.py
profile                        : /usr/lib64/python3.4/profile.py
PyFoam.ThirdParty.ply.yacc     : /usr/lib/python3.4/site-packages/PyFoam/ThirdParty/ply/yacc.py
PyFoam.ThirdParty.pyratemp     : /usr/lib/python3.4/site-packages/PyFoam/ThirdParty/pyratemp.py
PyFoam.ThirdParty.six          : /usr/lib/python3.4/site-packages/PyFoam/ThirdParty/six.py
PyFoam.ThirdParty.tqdm         : /usr/lib/python3.4/site-packages/PyFoam/ThirdParty/tqdm/__init__.py
PyFoam.ThirdParty.winhacks     : /usr/lib/python3.4/site-packages/PyFoam/ThirdParty/winhacks.py

Checking additional envirnoment variables

Checking for PYFOAM_DIR : Location of the PyFoam-installation. Not strictly necessary
PYFOAM_DIR missing from environment

Checking for PYFOAM_SITE_DIR : Location of non-PyFoam-disctributions script. Set and used by some Foam-distributions
PYFOAM_SITE_DIR missing from environment

User information
Temporary directory:  /tmp/PyFoam_Matt

I also issued:

pyFoamPlotWatcher.py --version

and got this:

Traceback (most recent call last):
  File "/usr/lib/python3.4/site-packages/PyFoam/ThirdParty/Gnuplot/PlotItems.py", line 28, in <module>
    import numpy
ImportError: No module named 'numpy'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/usr/bin/pyFoamPlotWatcher.py", line 3, in <module>
    from PyFoam.Applications.PlotWatcher import PlotWatcher
  File "/usr/lib/python3.4/site-packages/PyFoam/Applications/PlotWatcher.py", line 6, in <module>
    from PyFoam.Execution.GnuplotRunner import GnuplotWatcher
  File "/usr/lib/python3.4/site-packages/PyFoam/Execution/GnuplotRunner.py", line 4, in <module>
    from .StepAnalyzedCommon import StepAnalyzedCommon
  File "/usr/lib/python3.4/site-packages/PyFoam/Execution/StepAnalyzedCommon.py", line 6, in <module>
    from PyFoam.Execution.AnalyzedCommon import AnalyzedCommon
  File "/usr/lib/python3.4/site-packages/PyFoam/Execution/AnalyzedCommon.py", line 7, in <module>
    from PyFoam.Basics.PlotTimelinesFactory import createPlotTimelines,createPlotTimelinesDirect
  File "/usr/lib/python3.4/site-packages/PyFoam/Basics/PlotTimelinesFactory.py", line 4, in <module>
    from PyFoam.Basics.GnuplotTimelines import GnuplotTimelines,validTerminals
  File "/usr/lib/python3.4/site-packages/PyFoam/Basics/GnuplotTimelines.py", line 4, in <module>
    from PyFoam.ThirdParty.Gnuplot import Gnuplot,Data,gp
  File "/usr/lib/python3.4/site-packages/PyFoam/ThirdParty/Gnuplot/__init__.py", line 166, in <module>
    from .PlotItems import PlotItem, Func, File, Data, GridData
  File "/usr/lib/python3.4/site-packages/PyFoam/ThirdParty/Gnuplot/PlotItems.py", line 31, in <module>
    import numpypy
ImportError: No module named 'numpypy'

I keep seeing warnings about numpy missing. So taking a guess at it, I issued:

sudo zypper install python-numpy

and got this:

Loading repository data...
Warning: Repository 'openSUSE-13.2-Update' appears to be outdated. Consider using a different mirror or server.
Warning: Repository 'openSUSE-13.2-Update-Non-Oss' appears to be outdated. Consider using a different mirror or server.
Reading installed packages...
'python-numpy' is already installed.
No update candidate for 'python-numpy-1.9.0-1.6.x86_64'. The highest available version is already installed.
Resolving package dependencies...

Nothing to do.

This infers that numpy is already installed. But I'm not sure why pyFoam can't find it.

Any ideas?

Thanks again,
M Ridzon

[m_ridzon]

Update. I think I found it. I installed numpy-devel, since it looked like it was missing. I re-ran the installation for PyFoam and got this:

Matt@LinuxBox:~> sudo pip install PyFoam
root's password:
Requirement already satisfied (use --upgrade to upgrade): PyFoam in /usr/lib/python3.4/site-packages
Requirement already satisfied (use --upgrade to upgrade): numpy in /usr/lib64/python3.4/site-packages (from PyFoam)
Cleaning up...
Matt@LinuxBox:~> pyFoamPlotWatcher.py --version
pyFoamPlotWatcher.py 0.6.7

I ran a sample simulation and gnuplot opened and plotted the residuals in real time, which was what I'm after. Great! Now on to learning how to use gnuplot so I can zoom and set views for more sensible plot viewing. I'll poke around Google to try and figure that out.

Thanks,
M Ridzon

[OlivierM]

Hi,

I went through your process but unfortunately that didn't work for me

#
$ sudo pip install PyFoam
sudo: pip: command not found

$ sudo pip3 install PyFoam
Requirement already satisfied: PyFoam in /usr/local/lib/python3.8/dist-packages/PyFoam-2020.5-py3.8.egg (2020.5) Requirement already satisfied: numpy in /usr/lib/python3/dist-packages (from PyFoam) (1.17.4)

$ pyFoamPlotWatcher.py --version
Traceback (most recent call last):
File "/usr/local/bin/pyFoamPlotWatcher.py", line 4, in <module>
__import__('pkg_resources').run_script('PyFoam==20 20.5', 'pyFoamPlotWatcher.py')
File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 667, in run_script
self.require(requires)[0].run_script(script_name, ns)
File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 1452, in run_script
raise ResolutionError(
pkg_resources.ResolutionError: Script 'scripts/pyFoamPlotWatcher.py' not found in metadata at '/home/<USER>/.local/lib/python3.8/site-packages/PyFoam-2020.5.dist-info'
#

would you have any idea of what coul be the problem ?

I am running OFv2012 on Unbuntu 20.04 LTS wl2

many thanks

[gschaider]

Originally Posted by OlivierM

Hi,

I went through your process but unfortunately that didn't work for me

#
$ sudo pip install PyFoam
sudo: pip: command not found

$ sudo pip3 install PyFoam
Requirement already satisfied: PyFoam in /usr/local/lib/python3.8/dist-packages/PyFoam-2020.5-py3.8.egg (2020.5) Requirement already satisfied: numpy in /usr/lib/python3/dist-packages (from PyFoam) (1.17.4)

$ pyFoamPlotWatcher.py --version
Traceback (most recent call last):
File "/usr/local/bin/pyFoamPlotWatcher.py", line 4, in <module>
__import__('pkg_resources').run_script('PyFoam==20 20.5', 'pyFoamPlotWatcher.py')
File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 667, in run_script
self.require(requires)[0].run_script(script_name, ns)
File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 1452, in run_script
raise ResolutionError(
pkg_resources.ResolutionError: Script 'scripts/pyFoamPlotWatcher.py' not found in metadata at '/home/<USER>/.local/lib/python3.8/site-packages/PyFoam-2020.5.dist-info'
#

would you have any idea of what coul be the problem ?

I am running OFv2012 on Unbuntu 20.04 LTS wl2

many thanks

Hm. Strange. pkg_resource is never used in the PyFoam-sources so the script at /usr/local/bin/pyFoamPlotWatcher.py seems to be an automatically generated script that calls the original.
I can't reproduce this on my Ubuntu 18.04 with Python 3.8 so it seems to by a 20.04 problem (probably Canonical trying to reinvent the wheel in an improved way)


Does pyFoamVersion.py work and what is the output of that (PLEASE use the CODE-environment when adding computer output to your posts here. It makes things easier to read as it won't be reformatted)

[OlivierM]

Hi,
I can see the pyFoam installed version here below:

#
$ pip3 install pyFoam
> Requirement already satisfied: pyFoam in ./.local/lib/python3.8/site-packages (2020.5)
Requirement already satisfied: numpy in /usr/lib/python3/dist-packages (from pyFoam) (1.17.4)
#

but if I run 'pyFoamVersion.py' then I get the following:

#
$ pyFoamVersion.py
> Traceback (most recent call last):
File "/usr/local/bin/pyFoamVersion.py", line 4, in <module>
__import__('pkg_resources').run_script('PyFoam==20 20.5', 'pyFoamVersion.py')
File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 667, in run_script
self.require(requires)[0].run_script(script_name, ns)
File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 1452, in run_script
raise ResolutionError(
pkg_resources.ResolutionError: Script 'scripts/pyFoamVersion.py' not found in metadata at
'/home/<USER>/.local/lib/python3.8/site-packages/PyFoam-2020.5.dist-info'
#

sorry but I don't know what you mean by using the the CODE-environment.
... could you kindly explain me how to do that ?

thank you

[gschaider]

Originally Posted by OlivierM

Hi,
I can see the pyFoam installed version here below:

#
$ pip3 install pyFoam
> Requirement already satisfied: pyFoam in ./.local/lib/python3.8/site-packages (2020.5)
Requirement already satisfied: numpy in /usr/lib/python3/dist-packages (from pyFoam) (1.17.4)
#

but if I run 'pyFoamVersion.py' then I get the following:

#
$ pyFoamVersion.py
> Traceback (most recent call last):
File "/usr/local/bin/pyFoamVersion.py", line 4, in <module>
__import__('pkg_resources').run_script('PyFoam==20 20.5', 'pyFoamVersion.py')
File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 667, in run_script
self.require(requires)[0].run_script(script_name, ns)
File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 1452, in run_script
raise ResolutionError(
pkg_resources.ResolutionError: Script 'scripts/pyFoamVersion.py' not found in metadata at
'/home/<USER>/.local/lib/python3.8/site-packages/PyFoam-2020.5.dist-info'
#

sorry but I don't know what you mean by using the the CODE-environment.
... could you kindly explain me how to do that ?

thank you

When you look in the editor there is an icon with a # (help text: "Wrap CODE tags around selected text")


Problem seems to be that in the sources most PyFoam-scripts look like this

#! /usr/bin/env python 

from PyFoam.Applications.PlotWatcher import PlotWatcher 

 PlotWatcher()

when pip installs them it usually rewrites them to something like

#! /usr/bin/python38 

from PyFoam.Applications.PlotWatcher import PlotWatcher 

  PlotWatcher()

to make sure that the python-interpreter of the pip-tool is always used. Seems that in your case it completely rewrites it to indirectly get the script from somewhere else (what confuses me is that your script is installed on a system level but then tries to access files that belong to the user). I don't know what it is. I tried reproducing it on my machine with Python 3.8 and it works as expected. So it is either a speciality of Ubuntu 20-04 or the WSL environment


Could you post the content of your /usr/local/bin/pyFoamVersion.py (only the first few lines if it is longer than 10 lines)

[OlivierM]

here is the content of pyFoamVersion.py:

#!/usr/bin/python3
# EASY-INSTALL-SCRIPT: 'PyFoam==2020.5','pyFoamVersion.py'
__requires__ = 'PyFoam==2020.5'
__import__('pkg_resources').run_script('PyFoam==20 20.5', 'pyFoamVersion.py')

[gschaider]

Originally Posted by OlivierM

here is the content of pyFoamVersion.py:

#!/usr/bin/python3
# EASY-INSTALL-SCRIPT: 'PyFoam==2020.5','pyFoamVersion.py'
__requires__ = 'PyFoam==2020.5'
__import__('pkg_resources').run_script('PyFoam==20 20.5', 'pyFoamVersion.py')

That would have been a good example to demonstrate that you understood the CODE-tag


Anyway: that is strange. This script looks like it was installed with easy_install (which is old tech) not pip. You did not try to install it with a different way before you tried pip?

[OlivierM]

well,
apologies again for the CODE-tag.

I don't remember having tried anything else than pip (or pip3 indeed)

if I come back to the error then the last line quotes the following message:

pkg_resources.ResolutionError: Script 'scripts/pyFoamVersion.py' not found in metadata at '/home/oml_400/.local/lib/python3.8/site-packages/PyFoam-2020.5.dist-info'

here is the METADATA content:

Metadata-Version: 2.0
Name: PyFoam
Version: 2020.5
Summary: Python Utilities for OpenFOAM
Home-page: http://openfoamwiki.net/index.php/Contrib/PyFoam
Author: Bernhard F.W. Gschaider
Author-email: bgschaid@hfd-research.com
License: GPL
Keywords: cfd openfoam
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
Requires-Dist: numpy

# Table of Contents

1. [What it is](#org8e27d27)
2. [Installation](#org5380b22)
3. [License](#orgf26070d)
4. [Contributors](#org0388d7f)
5. [Further reading](#org820f59e)
6. [This document](#orgca16204)


<a id="org8e27d27"></a>

# What it is

The purpose of this library is to support working with the OpenSource
CFD-toolbox [OpenFOAM](http://www.openfoam.org) and its forks

This [Python](http://www.python.org) library can be used to

- analyze the logs produced by OpenFoam-solvers
- execute OpenFoam-solvers and utilities and analyze their output
simultaneously
- manipulate the parameter files and the initial-conditions of a run
in a non-destructive manner
- plots the residuals of OpenFOAM solvers
- lots of other stuff

Most of this functionality is made available to the user in the form
of command-line utilities.

PyFoam does all this strictly "from the outside": by writing parameter
files and reading the output of the solvers. Without compiled parts or
being linked to OpenFOAM.

More information is found on [the OpenFOAM Wiki](http://openfoamwiki.net/index.php/Contrib_PyFoam).
Introductory presentations on PyFoam can be found there


<a id="org5380b22"></a>

# Installation

The easiest way to install PyFoam is the Python package-manager `pip`:

pip install PyFoam

which will install PyFoam


<a id="orgf26070d"></a>

# License

PyFoam is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version. See the file COPYING in this directory,
for a description of the GNU General Public License terms under which
you can copy the files.


<a id="org0388d7f"></a>

# Contributors

If not otherwise noted in a source-files the primary author is Bernhard Gschaider

The people who contributed to PyFoam (If I forgot someone: tell me):

- Bernhard Gschaider
- Martin Beaudoin
- Fabian Pollesböck
- Etienne Lorriaux
- Bruno Santos
- Marc Immer
- Oliver Borm


<a id="org820f59e"></a>

# Further reading

These documents give further information

- **ReleaseNotes:** list of the changes between versions (newest
versions are on top).
- **DeveloperNotes:** document with information for people who want to
contribute to `PyFoam`

For information on the usage see the presentations on [the `PyFOAM`
page on the OpenFOAM-Wiki](https://openfoamwiki.net/index.php/Contrib_PyFoam)


<a id="orgca16204"></a>

# This document

The original source of this document is `README.org`. The
`README.md` (to which the `README` links) is automatically generated
and should **not** be edited. The reason for this setup is that most
Web-GUIs for VCS insist on Markdown as a markup language

here is the metadata.json content:

{"classifiers": ["Development Status :: 5 - Production/Stable", "Intended Audience :: Science/Research", "Topic :: Scientific/Engineering", "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9"], "description_content_type": "text/markdown", "extensions": {"python.details": {"contacts": [{"email": "bgschaid@hfd-research.com", "name": "Bernhard F.W. Gschaider", "role": "author"}], "document_names": {"description": "DESCRIPTION.rst"}, "project_urls": {"Home": "http://openfoamwiki.net/index.php/Contrib/PyFoam"}}}, "extras": [], "generator": "bdist_wheel (0.30.0)", "keywords": ["cfd", "openfoam"], "license": "GPL", "metadata_version": "2.0", "name": "PyFoam", "run_requires": [{"requires": ["numpy"]}], "summary": "Python Utilities for OpenFOAM", "version": "2020.5"}

is that helping ?

should I uninstall pyFoam and reinstall it ?

[OlivierM]

to complete the overview I have found 7 versions of the pyFoamVersion.py file:

the one under Ubuntu-20.04\home\<USER>\PyFoam-2020.5\PyFoam-2020.5\bin quotes these first 10 lines:

#!/usr/bin/env python
# Original provided by Mark Olesen

import os,sys
from platform import uname

# from __future__ import print_function
try:
    from PyFoam.ThirdParty.six import print_
except ImportError:

the one under Ubuntu-20.04\usr\local\bin quotes as follow:

#!/usr/bin/python3
# EASY-INSTALL-SCRIPT: 'PyFoam==2020.5','pyFoamVersion.py'
__requires__ = 'PyFoam==2020.5'
__import__('pkg_resources').run_script('PyFoam==2020.5', 'pyFoamVersion.py')

the one under Ubuntu-20.04\usr\local\lib\python3.8\dist-packages\PyFoam-2020.5-py3.8.egg\EGG-INFO\scripts quotes these first 10 lines:

#!/usr/bin/python3
# Original provided by Mark Olesen

import os,sys
from platform import uname

# from __future__ import print_function
try:
    from PyFoam.ThirdParty.six import print_
except ImportError:

the one under Ubuntu-20.04\home\<USER>\PyFoam-2020.5\PyFoam-2020.5\build\scripts-3.8 quotes these first 10 lines:

#!/usr/bin/python3
# Original provided by Mark Olesen

import os,sys
from platform import uname

# from __future__ import print_function
try:
    from PyFoam.ThirdParty.six import print_
except ImportError:

the one under Ubuntu-20.04\home\<USER>\PyFoam\bin quotes these first 10 lines:

#!/usr/bin/env python
# Original provided by Mark Olesen

import os,sys
from platform import uname

# from __future__ import print_function
try:
    from PyFoam.ThirdParty.six import print_
except ImportError:

the one under Ubuntu-20.04\home\<USER>\.local\bin quotes these first 10 lines:

#!/usr/bin/python3
# Original provided by Mark Olesen

import os,sys
from platform import uname

# from __future__ import print_function
try:
    from PyFoam.ThirdParty.six import print_
except ImportError:

the one under Ubuntu-20.04\home\<USER>\dist\PyFoam-2020.5\PyFoam-2020.5\bin quotes these first 10 lines:

#!/usr/bin/env python
# Original provided by Mark Olesen

import os,sys
from platform import uname

# from __future__ import print_function
try:
    from PyFoam.ThirdParty.six import print_
except ImportError:

[gschaider]

Originally Posted by OlivierM

to complete the overview I have found 7 versions of the pyFoamVersion.py file:

the one under Ubuntu-20.04\home\<USER>\PyFoam-2020.5\PyFoam-2020.5\bin quotes these first 10 lines:
<snip>

They all look good except for the one that is actually used. Which could also work but looks for the script in the wrong place. Best advice I can give you: "pip uninstall PyFoam". Make sure that none of these files is present anymore. Try "pip install" again. If it doesn't work check whether all these files are there again