Getting started

Executables

Latest windows executables can be downloaded here

Unpack the folder and launch the .exe files for the different tools stereoproj, diffraction, kikuchi,misorientation,interface and crystal.

From python

Note

Consider that it is often recommended to install packages in a virtual environnement to avoid breaking dependancies for other scripts. Please refer to the document to use pipx/poetry/venv/pyenv.

Prerequisites

pycotem relies on python3 since versions 2.x.x, with numpy>=1.19.0, pillow>=7.2.0, matplotlib>=3.3.0. Dependancies can be installed with pip. GUI relies on pyqt5. Earlier 1.x.x versions relies on python 2.7 with numpy>=1.13.3, pillow>=5.3.0, matplotlib>=2.1.1 and pyqt4

Installing and running

On windows

  • Install python 3 from python.org

  • Install pycotem and dependancies

pip install pycotem
pip install matplotlib
pip install pyqt5

Run the packages with

python -m pycotem.xxxx
where xxxx is one of the tool stereoproj, diffraction, kikuchi,misorientation,interface and crystal.

On Ubuntu

  • Install pip3
sudo apt-get install python3-pip
  • Install pycotem and dependancies
pip3 install pycotem
pip3 install matplotlib
  • Install pyqt5:
sudo apt-get install python-qt5
  • Run the script with
python3 -m pycotem.xxx

On MacOS X

  • Install Python from python.org or from Homebrew brew install python3

  • Install pycotem, matplotlib and pyqt5 with pip3 as above.

pip3 install pycotem
pip3 install matplotlib
pip3 install pyqt5
  • Run the script as above

Updating

  • Use pip3 install --upgrade pycotem

Examples

Image files and setting parameters for testing diffraction, interface and kikuchi can be found here