Detailed Installation Instructions (Windows)

Set up Anaconda

It is recommended to install Anaconda to contain all the global scripts.

https://www.anaconda.com/download/success

It should not matter if you register it as your default Python distribution, Visual Studio Code shouldn't have any issues finding your conda environments.

In the Windows search bar, type "anaconda" and right click "Anaconda Prompt" to pin it to your taskbar or pin it to the start menu (this will make it easier to access the Anaconda command prompt.

Open an Anaconda prompt and create a new Anaconda environment for using XRDpy

conda create --name xrd python=3.11

You can then use this new environment with

conda activate xrd

Optional package for fast GIWAXS image transforms

The gixpy package is currently only compatible with Windows. It requires a C compiler to install; there are two options: install the Microsoft C++ Build Tools or install Visual Studio. Either way, for the install you will need to select the "Desktop development with C++". After installing one of these you can simply pip install the package:

pip install -U gixpy

Set up VS Code

This is the preferred IDE for Jupyter Notebooks (it can also be used to edit LaTeX, markdown, Python, C, etc)

https://code.visualstudio.com/download

In the installer, under Select Additional Tasks make sure you have all the "Other" options selected

• Add "Open with Code" action to Windows Explorer file context menu
• Add "Open with Code" action to Windows Explorer directory context menu
• Register Code as an editor for supported file types
• Add to PATH (requires shell restart)

All of the above features will be useful.

Launch VS Code and pin it to the taskbar

In the left pane, select the the "Extensions" tab (or press Ctrl+Shift+X)

Install the following extensions

• Jupyter
• Jupyter Cell Tags
• Jupyter Slide Show
• Pylance
• Python
• Python Debugger

Set up GitHub

Download and install Github Desktop

https://desktop.github.com/

Open the application and select "File->Clone Repository" and then select the "URL" tab. In the "Repository URL or GitHub username and repository" text box, enter UCBoulder/XRDpy. The "Local path" should be to where you prefer to clone your repositories. It is typical to have a specific directory (often in your Documents directory) called "Git" or "GitHub" where you can organize your repositories. DO NOT clone XRDpy directly to your Documents folder (the install will create a folder called XRDpy in your Documents for storing certain useful files).

Install XRDpy

The installation requires pyyaml, so start with

pip install -U pyyaml

Then you can install XRDpy with

pip install -U [path\to\XRDpy]

where [path\to\XRDpy] is the file path to XRDpy wherever you cloned it.

Optional step for computers with GPUs

For pyFAI to leverage the GPU, you need to finish with this last step

pip install pyFAI[gui] --upgrade