Differences

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

--- processing:minimal_software_intallation [2023/03/13 12:31] – created smerkel
+++ processing:minimal_software_intallation [2026/08/10 10:22] (current) – smerkel
@@ Line 1: / Line 1: @@
-====== Minimal software kit installation ======
+====== Getting started with a Python environment ======
 There is a whole suite of software required to run multigrain X-ray diffraction, and their installation procedure can be quite tricky if you are not comfortable with computing techniques.
-The procedure below was tested with a recent Windows laptop. We proceed as follow:
+The recommended method is to install a python dedicated environement. This has been tested on Linux, but should also work on mac and windows, if you have a working python installation (**Instructions from a Windows user would be most welcome**).
- * Install a linux Ubuntu virtual machine
- * Set-up anaconda
- * Install the multigrain software suite within anaconda
-===== Install a linux Ubuntu virtual machine =====
+It is best to create and activate a virtual python environements dedicated to 3D-XRD. A virtual environment in Python is an isolated environment on your computer, where you can run and test your Python projects, without interfering with the main python installation or the rest of your computer system.
-There are many tutorials on how to do so on the internet. Here is a quick summary of how we proceeded
+See instructions at [[https://www.w3schools.com/python/python_virtualenv.asp]] and many other places online.
-  * Download and install VirtualBox from [[https://www.virtualbox.org/]]
-  * Download a recent Ubuntu Desktop linux from [[https://ubuntu.com/download/desktop]]
-  * Install Ubuntu within a VirtualBox virtual machine
-===== Anaconda =====
+Typically this is done by
+	# Creating a dedicated folder
+	# Move into this folder, and create a dedicated python environment for 3D-XRD work
+	python3 -m venv .venv
+To activate the environment, move into the folder in which it was created, and type
+	source .venv/bin/activate
+To de-active the environment, simple type
+	deactivate
-Anaconda is a distribution of the python and other programming languages for scientific computing. It makes it much easier to install and manage packages without messing up your environment or interfering with the operating system.  It is
- that aims to simplify package management and deployment. The distribution includes data-science packages suitable for Windows, Linux, and macOS. It is developed and maintained by Anaconda, Inc., which was founded by Peter Wang and Travis Oliphant in 2012.[8] As an Anaconda, Inc. product, it is also known as Anaconda Distribution or Anaconda Individual Edition, while other products from the company are Anaconda Team Edition and Anaconda Enterprise Edition, both of which are not free.[6][7]
-We will use Anaconda, which allows to install and run software without interfering with the operating system
+===== Install ESRF data analysis tools, fabio, silx, and ImageD11 =====
-Installing Anaconda
+Within a terminal in which your environement is activated
+	pip3 install fabio
+	pip3 install silx
+	pip3 install ImageD11
+	pip3 install Pmw
-Download Anaconda from https://www.anaconda.com/products/distribution
+===== Install additional Fable-3DXRD packages by hand =====
-Install anaconda
-	sh Download/Anconda……. (change file name according to what was downloaded)
-Keep note of where anaconda will be installed, typically /home/ningma/anaconda3
-Keep note of the instructions at the end of the anadonda installation as you may have to type those commands each time you start a new terminal. In our case
+==== TIMEleSS Viewer ====
-	eval “$(/home/ningma/anaconda3/bin/conda shell.bash hook)”
-	conda init
-Install ESRF data analysis tools, fabio, silx, and ImageD11
+The TIMEleSS Viewer  is very handy to visualize diffraction images, figure out detector orientations, identify parameters for peak extraction, etc.
-Within a terminal in which anaconda is activated
+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
-	pip3 install fabio
+	cd Fable-3DXRD-Folder
-	pip3 install silx
+	git clone https://github.com/FABLE-3DXRD/TIMEleSS_Viewer.git
-	pip3 install ImageD11
+	cd TIMEleSS_Viewer
+	python3 setup.py build
+	python3 setup.py install
-Install additional packages by hand
+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
-Fabian
+To start the TIMEleSS Viewer, simple type ''timelessViewer'' within your environement.
-	pip3 install Pmw (required by fabian)
-	Download fabian
-	Move into folder with fabian
-		python3 setup.py build
-		python3 setup.py install
-If you want to simulate data for training, you need  PolyXSim
+==== PolyXSim ====
-	Create a folder to download: mkdir ~/Fable/PolyXSim
-	If you do not have a copy already: git clone https://github.com/FABLE-3DXRD/PolyXSim.git
+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:
-	Otherwise: git pull
+	cd Fable-3DXRD-Folder
+	git clone https://github.com/FABLE-3DXRD/PolyXSim.git
+	cd PolyXSim
 	python3 setup.py build
 	python3 setup.py install
-Specifics for DAC experiments: TIMEleSS-tools
+If you need to update PolyXSim:
-	If you do not have a copy already: git clone https://github.com/FABLE-3DXRD/TIMEleSS.git
+	cd Fable-3DXRD-Folder
+	cd PolyXSim
+	git pull
+	python3 setup.py build
+	python3 setup.py install
+==== TIMEleSS-tools ====
+The TIMEleSS-tools include many helpers, guis, etc that were developed along with this tutorial. You will probably need them.
+If you never installed the TIMEleSS-tools:
+	cd Fable-3DXRD-Folder
+	git clone https://github.com/FABLE-3DXRD/TIMEleSS.git
 	cd TIMEleSS
-	Otherwise: git pull
 	python3 setup.py build
 	python3 setup.py install
-Installing grainspotter
+Otherwise, if you simply want to update your local copy:
+	cd Fable-3DXRD-Folder
+	cd TIMEleSS
+	git pull
+	python3 setup.py build
+	python3 setup.py install
+==== Grainspotter ====
+Grainspotter is often used to index grains. It is a plain C code, with [[software:grainspotter|instructions described here]].
+===== Wrap-up =====
+If you made it here, you are done! You can follow other pages of this wiki to get started. Good luck!
-conda install -c fable grainspotter