# Install BornAgain on BornAgain

file:///usr/share/doc/bornagain/html/deploy/install/index.html Recent content in Install BornAgain on BornAgain Hugo en-us

# Linux

file:///usr/share/doc/bornagain/html/deploy/install/linux.html Mon, 01 Jan 0001 00:00:00 +0000 file:///usr/share/doc/bornagain/html/deploy/install/linux.html <h2 id="install-on-linux">Install on Linux</h2> <h3 id="prequisites">Prequisites</h3> <h5 id="python">Python</h5> <p>As a prerequisite, Python must be installed. For the recommended installation under pyenv, see <a href="file:///usr/share/doc/bornagain/html/deploy/py/linux">Python on Linux</a>.</p> <h5 id="glibc">glibc</h5> <p>Our BornAgain binaries (pip package and installer) are built on Debian 11 and require <a href="https://www.gnu.org/software/libc">glibc</a> version 2.31 or higher.</p> <p>To see which glibc version is available on your system, run</p> <pre tabindex="0"><code>$ ldd --version </code></pre><p>Versions for other Linux distributions can be seen at <a href="https://repology.org/project/glibc/versions">https://repology.org/project/glibc/versions</a></p> <h3 id="installation-methods">Installation methods</h3> <h5 id="as-python-only-package">as Python-only package</h5> <p>If the BornAgain GUI is not required as only Python scripting mode is to be used, then BornAgain can be installed as a Python package from the <code>pip</code> repository:</p>

# Windows

file:///usr/share/doc/bornagain/html/deploy/install/windows.html Mon, 01 Jan 0001 00:00:00 +0000 file:///usr/share/doc/bornagain/html/deploy/install/windows.html <h2 id="install-on-windows">Install on Windows</h2> <h4 id="install-python-environment">Install Python environment</h4> <p>As a prerequisite, Python must be installed, see <a href="file:///usr/share/doc/bornagain/html/deploy/py/win">Python on Windows</a>.</p> <h4 id="install-bornagain-as-a-python-package">Install BornAgain as a Python package</h4> <p>To install BornAgain as a pure Python package (for scripting only, no GUI), download and install the latest BornAgain Python wheel from the <a href="https://pypi.org">PyPI</a> repository:</p> <pre tabindex="0"><code>$ python -m pip install bornagain </code></pre><h4 id="install-full-bornagain-gui-and-python-scripting">Install full BornAgain (GUI and Python scripting)</h4> <p>To install full BornAgain (GUI app and Python module), download an installer from <a href="https://bornagainproject.org/ext/files/23.0">https://bornagainproject.org/ext/files/23.0</a>. The installer should be chosen accordingly to the Python minor version installed on the destination machine, for example <code>BornAgain-23.0-python3.12-win64.exe</code>.</p>

# MacOS

file:///usr/share/doc/bornagain/html/deploy/install/macos.html Mon, 01 Jan 0001 00:00:00 +0000 file:///usr/share/doc/bornagain/html/deploy/install/macos.html <h2 id="install-on-macos">Install on MacOS</h2> <h4 id="prequisite-python">Prequisite: Python</h4> <p>As a prerequisite, Python must be installed, see <a href="file:///usr/share/doc/bornagain/html/deploy/py/mac">Python on Mac</a>.</p> <h4 id="install-bornagain-gui-application">Install BornAgain GUI application</h4> <p>To install BornAgain on MacOS, one should use the official MLZ Homebrew Tap hosted at <a href="https://jugit.fz-juelich.de/mlz/homebrew/">https://jugit.fz-juelich.de/mlz/homebrew/</a>.</p> <p>First, add the tap to the local Homebrew taps via</p> <pre tabindex="0"><code>$ brew tap mlz/homebrew https://jugit.fz-juelich.de/mlz/homebrew/ </code></pre><p>After that, Homebrew will be able to work with formulae in <code>mlz/homebrew</code> as if they were in <code>homebrew-core</code> canonical repository.</p> <p>To install BornAgain v22.2 from the tap, use</p>

# Development snapshot

file:///usr/share/doc/bornagain/html/deploy/install/snapshot.html Mon, 01 Jan 0001 00:00:00 +0000 file:///usr/share/doc/bornagain/html/deploy/install/snapshot.html <h2 id="install-development-snapshot">Install development snapshot</h2> <p>Usually, we recommend installing the latest public release. However, users who need specific novel features or/and are willing to help us as testers are welcome to download the latest development snapshot.</p> <p>Here, we explain the download path for Windows. For other platforms, pertinent paths will be easily found by analogy.</p> <p>Go to the jobs listing at <a href="https://jugit.fz-juelich.de/mlz/bornagain/-/jobs">https://jugit.fz-juelich.de/mlz/bornagain/-/jobs</a>.</p> <p>Look for an entry like <figure class="float-left"> <a href="file:///usr/share/doc/bornagain/html/img/job_win_main.png"> <img src="file:///usr/share/doc/bornagain/html/img/job_win_main.png" > </a> <figcaption> <p></p> </figcaption> </figure> that has the green tag <img src="file:///usr/share/doc/bornagain/html/img/job_tag_passed.png"/>, the gray tag <img src="file:///usr/share/doc/bornagain/html/img/job_tag_main.png"/>, and the blue tag <img src="file:///usr/share/doc/bornagain/html/img/job_tag_win.png"/>.</p>