Installation#

Requirements#

  • Python 3.8 or higher

  • NumPy >= 1.20

  • Matplotlib >= 3.5

  • PySide6 >= 6.0

Installing from Source#

  1. Clone the repository:

git clone https://gitlab.com/gbegou/zefir.git
cd zefir

  1. Install in development mode:

pip install -e .

This will install all dependencies automatically.

Verifying Installation#

Test that the CLI works correctly:

python -m zefir --help

Or test the GUI directly:

python -m zefir potentialflow --help

You can also test programmatically:

python -c "from zefir.gui.potential import PotentialFlowGUI; print('Installation successful!')"

Or run the test script:

python sandbox/test_gui.py

Command-Line Interface#

After installation, ZEFIR provides a command-line interface:

# Show all available commands
python -m zefir --help

# Launch the potential flow GUI
python -m zefir potentialflow

# Show potential flow options
python -m zefir potentialflow --help

The CLI supports dynamic discovery of GUI packages, making it easy to extend with new applications.