BornAgain ≻ git-develop ≻ Documentation ≻ Install or build ≻ Build BornAgain ≻ Unix ≻ Run a first simulation

Run a first simulation

This section explains how to run a first simulation.

Post installation steps

If a Python package is produced in the build phase, then after installation, the Python package (‘wheel’) can be found under the folder <install_dir>/python/<python-version>/wheel. The wheel can be installed via pip; for instance

python3 -m pip install bornagain-<detailed-wheel-tag>.whl

or

pip3 install bornagain-<detailed-wheel-tag>.whl

Running the first Python simulation

In your installation directory you will find the following directory structure:

|-- build              
|   |-- bin          - Links to executables
|   |-- lib          - The BornAgain libraries
|-- auto
|   |-- Examples     - Directory with examples
|-- Doc              - Dev documentation generation with Doxygen
|-- hugo             - User/Build documentation generation with hugo
...                  - Rest are C++ Development folders
|

Run an example and enjoy your first BornAgain simulation plot.

python <install_dir>/auto/Examples/scatter2d/CylindersAndPrisms.py

Running the BornAgain GUI

The BornAgain application can be run by executing following command

$ <install_dir>/bin/bornagain