The fluidfoam package provides Python classes useful to perform some plot with OpenFoam data.
- Openfoam Tools
- Version : 0.3.1
- Supported OpenFoam Versions : 2.4.0, 4.1 to 9, v1712plus to latest
- Supported Python Versions : >= 3.8
http://fluidfoam.readthedocs.org
We recommend installing fluidfoam in a Python virtual environment.
Create the virtual environment (only once):
python3 -m venv ~/pyenv
Activate it (each time you open a new terminal):
source ~/pyenv/bin/activate
Then install fluidfoam with pip:
pip install fluidfoam
You can get the source code from github or from the Python Package Index.
The development mode is often useful. First create and activate a virtual environment as described above, then install uv in it:
pip3 install uv
From the root directory of the repository, run:
make develop
This runs uv sync --active and installs fluidfoam in the currently
activated virtual environment, so make sure it is activated before.
Other useful commands:
make tests # run the test suite (pytest) make black # format the code (black, line length 82) make build # build the package (in dist/) make clean # remove dist/
A good starting point is to follow this forking tutorial.
Fork the repository on GitHub, then clone your fork:
git clone https://github.com/your_username/fluidfoam cd fluidfoam
Declare the main repository as the
upstreamremote (only once):git remote add upstream https://github.com/fluiddyn/fluidfoam
Create a branch for your changes instead of working on
master:git switch -c my-new-feature
Get the status of the repository:
git status
In case of new/modified file(s):
git add new_file
Format the code and check that the tests pass:
make black make tests
Commit a revision on the local repository:
git commit -m "comment on the revision"
Push the branch on your GitHub fluidfoam repository:
git push -u origin my-new-feature
To propose your changes into the main fluidfoam project, open a pull request from your branch (see the forking tutorial above).
To update your fork with the latest changes of the main project:
git fetch upstream git rebase upstream/master
- Julien.Chauchat@univ-grenoble-alpes.fr
- amathieu@udel.edu
- Remi.Chassagne@univ-grenoble-alpes.fr
- Quentin.Clemencot@univ-grenoble-alpes.fr
- Matthias.Renaud@univ-grenoble-alpes.fr
- Alban.Gilletta.De.Saint.Joseph@france-energies-marines.org
- Gabriel Goncalves
fluidfoam is distributed under the GNU General Public License v3 (GPLv3 or newer).