pydidas installation guide

Pydidas is a python package and required Python 3.11 or later. In addition, multiple other packages are required.
Using a tool like conda or pip allows to manage these other packages and fuirther dependencies.

It is recommended to use either an independent python installation or to use a python environment (for example using conda).

A. Creating a python environment using conda

1. A new environment for pydidas can be created in a shell with conda support (e.g. linux shell or Windows Anaconda Powershell)
Use the command

conda create -n pydidas python=3.11

to create the environment and activate it with:

conda activate pydidas

2. Install pydidas: A pydidas wheel is the most convenient way to install pydidas. The latest releases on Github also include published wheel files. Pydidas itself can then simply be installed using pip in the activated environment:

pip install pydidas-YY.MM.DD-py3-none-any.whl

where you need to replace the YY.MM.DD with the respective version you downloaded. If the file is located in a different directory, you need to give the relative path from your current directory (or the absolute path).

It is recommended to use pip for all dependencies as well because the wheel has pinned dependencies and the conda solver is very slow.

3. Start pydidas: the pydidas package is available through the regular import in python. A pre-defined GUI is available from inside the conda-environments and can be started with this command:

pydidas-gui

All available entry points are listed on the pydidas quick-start guide

B. Installation of a stand-alone python in Windows

1. It is recommended to use a stand-alone version of python without installer. The Windows embeddable package (64-bit) is recommended to use and can be found at python downloads. Search for the "Looking for a specific release?" und click on the version number to open a list of installers. Download the Windows embeddable package (64-bit) archive and unzip it to a location of your choice.

3. Install pip: Download the script get-pip.py into the folder with your unzipped python version and run the script:

python get-pip.py

3. Make pip available: To do this, remove the # in the last line of the the file pythonVV_.pth (replace VV with the python version).

4. Install the pydidas-wheel: Download the desired version from latest releases on Github. Using pip to install it will also install all required dependencies

pip install pydidas-YY.MM.DD-py3-none-any.whl

where you need to replace the YY.MM.DD with the respective version you downloaded.

5. Start pydidas: the pydidas package is available using the regular python import. A link to starting the GUI is also available using an entry point. A pre-defined GUI can be started directly using the script file:

cd Scripts
pydidas-gui.exe

(the GUI can also be opened by double-clicking pydidas-gui.exe in the Windows Explorer).