BornAgain ≻ 25.0 ≻ Documentation ≻ Install BornAgain ≻ macOS

Install on macOS

BornAgain for macOS is distributed through the project’s Homebrew tap, not as a wheel on PyPI.

Install with Homebrew

Install Apple’s Command Line Tools and Homebrew, then add the tap and install BornAgain:

xcode-select --install
brew tap mlz/homebrew https://jugit.fz-juelich.de/mlz/homebrew/
brew install mlz/homebrew/bornagain@25.0.0

Homebrew installs BornAgain’s core Python dependencies automatically. Install optional packages (fabio, lmfit, periodictable, etc.) manually in its Python environment when needed.

Run the bornagain_info command to show the installation and example-script locations.

For general use of the tap, see its README.

Run scripts

brew --prefix bornagain@25.0.0 returns the BornAgain installation directory. Run scripts with the Python environment installed by Homebrew:

"$(brew --prefix bornagain@25.0.0)/venv/bin/python3" my_script.py

Install the wheel in another environment

The brew install command also builds the BornAgain wheel and installs it in this environment. To install the same wheel in another environment, activate one that uses the same Python version, then run:

python -m pip install "$(brew --prefix bornagain@25.0.0)"/share/BornAgain/wheel/*.whl