Install on Windows

Install Python environment

As a prerequisite, Python must be installed, see Python on Windows.

Install BornAgain as a Python package

To install BornAgain as a pure Python package (for scripting only, no GUI), download and install the latest BornAgain Python wheel from the PyPI repository:

$ python -m pip install bornagain

Install full BornAgain (GUI and scripting)

To install full BornAgain (GUI app and Python module), download an installer from The installer should be chosen accordingly to the Python minor version installed on the destination machine, for example BornAgain-21.0-python3.11-win64.exe.

After downloading the installer, double click the .exe file and follow the instructions on the screen.

Use the BornAgain icon located on the desktop to start the GUI. Refer to Using graphical user interface section for a basic overview of GUI functionality.


Frequent problems include the following:

BornAgain.exe cannot start

This message appears on running BornAgain.exe if BornAgain cannot find Python libraries.

If Python is correctly installed on the system according to Install Python environment, check if it discoverable by the system. Open command line or PowerShell and type

$ python

If Python interpreter has not started, then its installation directory is not in system PATH. Open

Edit the system environment variables -> Environment variables -> System variables -> Path -> Edit

and add Python installation directory to the end

How many Pythons are installed on the system?

Having more than one Python interpreter installed on the system may cause subtle errors. Managing their co-existence is possible, but may require special skills. It may be preferable to uninstall all Python versions but one.

Does the Python interpreter version match the BornAgain installation?

BornAgain is a 64-bit application and requires a 64-bit Python3 installed on the system.

The Python version number (major.minor), indicated in the BornAgain installer name (e.g. BornAgain-21.0-python3.11-win64.exe) must match the Python installation on your system.