Differences

This shows you the differences between two versions of the page.

--- software:fabian [2018/07/04 16:45] – [Installation] matthias
+++ software:fabian [2019/02/21 07:38] (current) – smerkel
@@ Line 1: / Line 1: @@
 ====== Fabian ======
-Fabian is designed for the purpose of viewing image file series. In particular
+Fabian is designed for the purpose of viewing image file series. In particular such diffraction image files obtained from synchrotron experiments. It was originally written by Henning Osholm Sørensen & Erik Knudsen from the Technical University of Denmark.
-such diffraction image files obtained from synchrotron experiments. It was originally written by Henning Osholm Sørensen & Erik Knudsen from the Technical University of Denmark.
 The current homepage for Fabian is at [[https://github.com/FABLE-3DXRD/fabian]].
@@ Line 8: / Line 7: @@
 ===== Installing Fabian =====
-==== Necessary Hardware and Software ====
+==== Necessary hardware and software ====
-First of all, you will need Linux, either as a separate harddrive (with lots of memory space) or as a virtual machine on your Windows/Apple computer. In case you are not familiar with Linux, ask your administrator for help and maybe do an online crash course to learn basic navigation and so on.
-Having Linux is a good start, but not enough. You will also need a couple of other programs. When you click on the [[https://github.com/FABLE-3DXRD/fabian|Fabian homepage]] and scroll down, there is a list of all the stuff you need in order to run Fabian properly. Most of the computers, which were working with Linux before, usually have installed most of these software/libraries already. But if you got a brandnew Linux from your IT guys, there is usually only the very basic stuff on it.
+Fabian is easier to install on Linux, either as a separate hard drive or as a virtual machine on your Windows/Apple computer. In case you are not familiar with Linux, ask your administrator for help.
-Now you have two options:
+Fabian will need other programs to run. The list is available on the [[https://github.com/FABLE-3DXRD/fabian|Fabian homepage]]. Scroll down, there is a list of all the stuff you need in order to run Fabian properly. If you have a newly installed linux from your IT guys, there is usually only the very basic stuff on it.
-  - Download and install all these packages one by one or
-  - Download and install Anaconda.
-The benefit of Anaconda is that it contains most of the necessary libraries and you are done with installations within 5 minutes. There are also several other advantages coming with Anaconda (for example the installation assistant for [[software:grainspotter|GrainSpotter]]).
+There are two ways:
+  - Add the missing python libraries using your linux distribution installer (e.g. //yast// in OpenSuse), which I what Seb does,
+  - Download and install [[https://www.anaconda.com/download/|Anaconda]].
+Anaconda includes the most recent versions of python and contains most of the necessary libraries. You will be done with installations within 5 minutes. There are also several other advantages coming with Anaconda (for example the installation assistant for [[software:grainspotter|GrainSpotter]]).
+Anaconda, on the other hand, is a cutting-edge version of python which may complain if you are using somewhat //older// libraries.
 ==== Installation ====
 Go to the [[https://github.com/FABLE-3DXRD/fabian|Fabian homepage]] and click on the green button "clone or download". Click on "Download ZIP". After the download is finished, navigate to the "Downloads" folder and unpack the ZIP folder to a directory of your choice.
-Open the Konsole and navigate to the unpacked Fabian directory. There should be a folder called "setup.py". Type the following to the Konsole:
+Open a terminal and navigate to the unpacked Fabian directory. There should be a folder called "setup.py". Type the following to the Konsole:
     python setup.py build
 If you get an error, there might be some of the additional libraries still missing.
+===== Running Fabian =====
 When the installation was successful you should be able to start Fabian by typing
     fabian.py
-in any folder.
-Be aware that the Konsole is now occupied with running Fabian. You have to open a second Konsole window if you want to do something else with the Konsole.
+Be aware that the terminal is now busy with running Fabian. If you want to get the terminal back, you should start  Fabian by typing
+    fabian.py &
+If you forgot the //&// sign, you can get the hand on the terminal back by typing ''Crt-Z'' and then ''bg'' in your terminal.
 ===== Screen shots =====
+This is how the main interface of Fabian looks like
+{{ :software:fabian.jpg?300 |}}
 ===== Useful features =====
+Fabian is used to visualize diffraction images. It includes many features which are particularly useful in processing multigrain diffraction data:
+  * the possibility to navigate through step scan images by simply clicking next, or previous,
+  * convenient zoom capabilities,
+  * a correct implementation of the fable orientation matrix, which you can use to figure out yours,
+  * the possibility to remove a background from the current image,
+  * the possibility to add peaks in overlay after running a peak search,
+  * and many others...
+[{{:backgrouundsubstraction.png?250 | Substracting a background in the Fabian display}}] [{{ :fabian.png?300| Showing peaks in Fabian}}]