How To Install bornagain-doc on Ubuntu

Posted on April 1, 2023 (Last modified on May 20, 2023 )

3 minutes • 577 words

Introduction

In this tutorial we learn how to install bornagain-doc on Ubuntu.

What is `bornagain-doc`

bornagain-doc is:

BornAgain is a software package to simulate and fit small-angle scattering at grazing incidence. It supports analysis of both X-ray (GISAXS) and neutron (GISANS) data. Calculations are carried out in the framework of the distorted wave Born approximation (DWBA). BornAgain provides a graphical user interface for interactive use as well as a generic Python and C++ framework for modeling multilayer samples with smooth or rough interfaces and with various types of embedded nanoparticles.

BornAgain supports:

Layers:

Multilayers without any restrictions on the number of layers
Interface roughness correlation
Magnetic materials

Particles:

Choice between different shapes of particles (form factors)
Particles with inner structures
Assemblies of particles
Size distribution of the particles (polydispersity)

Positions of Particles:

Decoupled implementations between vertical and planar positions
Vertical distributions: particles at specific depth in layers or on top.
Planar distributions:
- fully disordered systems
- short-range order distribution (paracrystals)
- two- and one-dimensional lattices

Input Beam:

Polarized or unpolarized neutrons
X-ray
Divergence of the input beam (wavelength, incident angles) following different distributions
Possible normalization of the input intensity

Detector:

Off specular scattering
Two-dimensional intensity matrix, function of the output angles

Use of BornAgain:

Simulation of GISAXS and GISANS from the generated sample
Fitting to reference data (experimental or numerical)
Interactions via Python scripts or Graphical User Interface

If you use BornAgain in your work, please cite C. Durniak, M. Ganeva, G. Pospelov, W. Van Herck, J. Wuttke (2015), BornAgain — Software for simulating and fitting X-ray and neutron small-angle scattering at grazing incidence, version , http://www.bornagainproject.org

This package contains the BornAgain documentation.

There are three methods to install bornagain-doc on Ubuntu. We can use apt-get, apt and aptitude. In the following sections we will describe each method. You can choose one of them.

Install bornagain-doc Using apt-get

Update apt database with apt-get using the following command.

sudo apt-get update

After updating apt database, We can install bornagain-doc using apt-get by running the following command:

sudo apt-get -y install bornagain-doc

Install bornagain-doc Using apt

Update apt database with apt using the following command.

sudo apt update

After updating apt database, We can install bornagain-doc using apt by running the following command:

sudo apt -y install bornagain-doc

Install bornagain-doc Using aptitude

If you want to follow this method, you might need to install aptitude first since aptitude is usually not installed by default on Ubuntu. Update apt database with aptitude using the following command.

sudo aptitude update

After updating apt database, We can install bornagain-doc using aptitude by running the following command:

sudo aptitude -y install bornagain-doc

How To Uninstall bornagain-doc on Ubuntu

To uninstall only the bornagain-doc package we can use the following command:

sudo apt-get remove bornagain-doc

Uninstall bornagain-doc And Its Dependencies

To uninstall bornagain-doc and its dependencies that are no longer needed by Ubuntu, we can use the command below:

sudo apt-get -y autoremove bornagain-doc

Remove bornagain-doc Configurations and Data

To remove bornagain-doc configuration and data from Ubuntu we can use the following command:

sudo apt-get -y purge bornagain-doc

Remove bornagain-doc configuration, data, and all of its dependencies

We can use the following command to remove bornagain-doc configurations, data and all of its dependencies, we can use the following command:

sudo apt-get -y autoremove --purge bornagain-doc

Dependencies

bornagain-doc have the following dependencies:

References

bornagain-doc website

Summary

In this tutorial we learn how to install bornagain-doc package on Ubuntu using different package management tools: apt, apt-get and aptitude.