Skip to content

Installation

Requirements

  • Python 3.10 or later
  • A Fortran compiler in PATH (e.g. gfortran, ifort, ifx)
  • Typer — installed automatically as a dependency (provides the CLI and shell completion)
  • Optional: PreForM.py for source preprocessing
  • Optional: FORD for the --ford intrinsic rule
  • Optional: graphviz Python package for dependency graph generation
bash
pip install FoBiS.py

Or with pipx for an isolated installation:

bash
pipx install FoBiS.py

Verify the installation:

bash
fobis -v
fobis --help

Enable shell tab completion (bash / zsh / fish / PowerShell):

bash
fobis --install-completion bash   # or zsh / fish / powershell

See Shell Completion for the full setup guide.

Windows

On Windows the entry point is created as FoBiS.py.exe in the Python Scripts directory. Use PowerShell (the default shell) rather than Git Bash, or invoke via fobis (the lower-case console entry point that resolves correctly in all shells).

Legacy command name

The FoBiS.py command is preserved as a backward-compatible alias. Both fobis and FoBiS.py invoke the same tool — existing scripts using FoBiS.py continue to work without changes.

From source

bash
git clone https://github.com/szaghi/FoBiS.git
cd FoBiS
pip install -e .

For development (editable install with all dev tools):

bash
pip install -e ".[dev]"

Programmatic use

FoBiS.py can be invoked from Python code without the CLI:

python
from fobis.fobis import run_fobis

# Equivalent to: fobis build --mode release
run_fobis(fake_args=['build', '--mode', 'release'])

The fake_args list accepts any arguments that would appear on the command line (both --option and legacy -option single-dash forms are accepted).