# Installation & Requirements

To run the _3DXRD_ workflow, ensure you have the following prerequisites:

- **Python**: Version 3.10 or above.
- **Data**: 3DXRD data stored in Bliss master files.
- **Correction Files**: Detector correction files (spline or .e2dx/.e2dy).
- **Geometry**: Initial geometry parameters (e.g., sample-detector distance). You can generate a `.par` file by following the [calibration guide](./calibration.md).
- **Lattice File**: CIF file containing the lattice of the 3DXRD sample

## Installation

### At ESRF

If you are working on an ESRF machine with access to the module system, **you do not need to install anything**. 

Simply load the pre-configured environment:

```bash
module load ewoks3dxrd
```
:::

### On a local machine

For use in your own Python environment, install the package via `pip`:

```bash
pip install ewoks3dxrd[full]
```

Using the `[full]` extra ensures that Orange (the graphical workflow editor) and all GUI dependencies are included.

### Test the installation

You can try that the program was correctly installed by running

```bash
ewoks-canvas
```

## Troubleshooting

There may be problems when launching `ewoks-canvas` on modern Linux distributions that uses Wayland (like Ubuntu 22.04+ or Fedora).

In this case, forcing Qt to use the Wayland backend often solves the mismatch with PyOpenGL’s EGL platform.

For this, set the following environment variables by running this in your terminal before launching `ewoks-canvas`:

```bash
export QT_QPA_PLATFORM=wayland
export PYOPENGL_PLATFORM=glx
```

If you encounter errors when working on a server (especially one accessed via SSH with X11 forwarding, or a remote desktop like VNC/NoMachine), you can try to set the environment variables diffrently by running (again before lauching `ewoks-canvas`):

```bash
export QT_QPA_PLATFORM=xcb
export PYOPENGL_PLATFORM=glx
export LIBGL_ALWAYS_SOFTWARE=1 # Prevents 'Failed to create context' errors
export QT_X11_NO_MITSHM=1      # Fixes shared memory issues on remote X11
```