Differences

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

--- processing:minimal_software_intallation [2026/08/10 10:10] – smerkel
+++ processing:minimal_software_intallation [2026/08/10 10:22] (current) – smerkel
@@ Line 10: / Line 10: @@
 Typically this is done by
-        Creating a dedicated folder
+	# Creating a dedicated folder
-        Move into this folder, and create a dedicated python environment for 3D-XRD work
+	# Move into this folder, and create a dedicated python environment for 3D-XRD work
-        python3 -m venv .venv
+	python3 -m venv .venv
-        Activate the environment:
+To activate the environment, move into the folder in which it was created, and type
-        source .venv/bin/activate
+	source .venv/bin/activate
+To de-active the environment, simple type
+	deactivate
@@ Line 20: / Line 22: @@
 ===== Install ESRF data analysis tools, fabio, silx, and ImageD11 =====
-Within a terminal in which anaconda is activated
+Within a terminal in which your environement is activated
 	pip3 install fabio
 	pip3 install silx
 	pip3 install ImageD11
+	pip3 install Pmw
-===== Install additional packages by hand =====
+===== Install additional Fable-3DXRD packages by hand =====
-==== Fabian ====
+==== TIMEleSS Viewer ====
-Fabian is very handy to visualize diffraction images, figure out detector orientations, identify parameters for peak extraction, etc. It is an old piece of software, but there is not real replacement at this point.
+The TIMEleSS Viewer  is very handy to visualize diffraction images, figure out detector orientations, identify parameters for peak extraction, etc.
-Start by installing the Pmw libray, which is required by fabian
-	pip3 install Pmw
 Create a folder for additional software somewhere on your hard disk, called ''Fable-3DXRD'' for instance. Move into this folder and create a clone of the repository at github
-	cd ~/Fable-3DXRD
+	cd Fable-3DXRD-Folder
-	git clone https://github.com/FABLE-3DXRD/fabian.git
+	git clone https://github.com/FABLE-3DXRD/TIMEleSS_Viewer.git
-	cd fabian
+	cd TIMEleSS_Viewer
 	python3 setup.py build
 	python3 setup.py install
-Next time, if you want to update your installation of fabian with a new version, you will not need to ''clone'' the directory. You will move into your folder and update it:
-	cd ~/Fable-3DXRD/fabian/
+Next time, if you want to update your installation of the TIMEleSS Viewer with a new version, you will not need to ''clone'' the directory. You will move into your folder and update it:
+	cd TIMEleSS_Viewe
 	git pull
 	python3 setup.py build
 	python3 setup.py install
-We did have a problem while install fabian, which was calling some obscure functions with OpenGL. Move looked into the fabian source code to de-activate those functions. This should be documented somewhere but we did not do it yet.
+To start the TIMEleSS Viewer, simple type ''timelessViewer'' within your environement.
 ==== PolyXSim ====
 If you want to simulate data for training, you need will PolyXSim. The procedure is very similar to that we used for fabian. If you never installed PolyXSim:
-	cd ~/Fable-3DXRD
+	cd Fable-3DXRD-Folder
 	git clone https://github.com/FABLE-3DXRD/PolyXSim.git
 	cd PolyXSim
@@ Line 57: / Line 59: @@
 If you need to update PolyXSim:
-	cd ~/Fable-3DXRD/PolyXSim
+	cd Fable-3DXRD-Folder
+	cd PolyXSim
 	git pull
 	python3 setup.py build
@@ Line 67: / Line 70: @@
 If you never installed the TIMEleSS-tools:
-	cd ~/Fable-3DXRD
+	cd Fable-3DXRD-Folder
 	git clone https://github.com/FABLE-3DXRD/TIMEleSS.git
 	cd TIMEleSS
@@ Line 74: / Line 77: @@
 Otherwise, if you simply want to update your local copy:
-	cd ~/Fable-3DXRD/TIMEleSS
+	cd Fable-3DXRD-Folder
+	cd TIMEleSS
 	git pull
 	python3 setup.py build
@@ Line 81: / Line 85: @@
 ==== Grainspotter ====
-Grainspotter is often used to index grains. It is available on conda:
+Grainspotter is often used to index grains. It is a plain C code, with [[software:grainspotter|instructions described here]].
-	conda install -c fable grainspotter
 ===== Wrap-up =====