fluid-sim-py

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #go #golang #android #machine-learning #macos #awesome #kubernetes #awesome-list #ios #openai

(★ 34)

No description available.

fluid-sim-py Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# fluid-sim-py
![Version](https://img.shields.io/badge/version-0.2.0-blue)

`fluid-sim-py` is a standalone Python application for real-time visualization of fluid flow, based on [Stable Fluids](https://pages.cs.wisc.edu/~chaol/data/cs777/stam-stable_fluids.pdf).

The simulation is designed for robustness with extensive in-line code documentation, making it easy to integrate new features. The underlying CFD solvers have been optimized with vectorization for efficient CPU usage (see [Benchmarks](#benchmarks) section).

## Features

- Interactive fluid manipulation  
  - Move fluid: `left-click + drag`  
  - Add fluid sources: `left-click + s`  
  - Draw boundaries/obstacles: `right-click + drag`

- GUI controls  
  - Adjust RGB color and width of boundaries  
  - Modify fluid source velocity

- Screen recording  
  - Capture the simulation in real time  
  - Saved as `fluid_sim.mp4` for later viewing

## Demo
![demo gif](https://raw.githubusercontent.com/Beniam-Kumela/fluid-sim-py/main/img/fluid-sim-py-demo.gif)
Click [here](https://youtu.be/M2LvjnQ8Ikw) for high-resolution video

## Installation

Run the following terminal commands (Unix machines)

```
git clone https://github.com/Beniam-Kumela/fluid-sim-py.git
cd fluid-sim-py
python -m pip install --user virtualenv
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python src/fluid-sim.py
```

If on Windows machine, instead of ```source venv/bin/activate``` run ```.\venv\Scripts\Activate.ps1```. If you get an error, run PowerShell as Administrator and type:

```
Set-ExecutionPolicy RemoteSigned
Y
```
Return to your terminal window, navigate back to the project directory and proceed with the `python -m venv venv` step.

## Benchmarks
| Architecture | Avg. FPS |
| - | - |
| M4 | 60 |
| i7 165U vPro | 25 |
|  |  |

All benchmarks were taken at Gauss-Seidel iterations = 16, grid dimension = 128x128, scaling factor = 5. Please update with this your personal machine performance.

## Contributing
Contributions are welcomed and appreciated! Fork and create a pull request on [GitHub](). We value the input and experiences all users and contributors bring to `fluid-sim-py`.

## Future
There are several features left to implement (feel free to extend this):
- GPU-based rendering with [Taichi](www.taichi-lang.org)
- Erase boundaries instead of returning to start menu

fluid-sim-py

fluid-sim-py Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

fluid-sim-py

fluid-sim-py Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README