Documentation

The documentation can be found on Read the Docs under this link.

Install Xana

1. Install Xana using pip:

   pip install Xana

2. Install most recent Xana version from GitHub: Download (clone) the repository and install Xana.

   git clone https://github.com/reiserm/Xana.git
   cd Xana
   pip install .

   or use pip install -e . for editable installation. Then you can update Xana by executing git pull from within the Xana directory.

   Install the latest version from GitHub directly with pip:

   pip install git+https://github.com/reiserm/Xana.git

Example Data

An example XPCS dataset can be downloaded from Xana_example. The repository contains

• Example XPCS data measured with 100nm (diameter) SiO2 nanoparticles dispersed in a glycerol-water mixture.
• A mask of the detector, i.e., a 2D array where bad or broken pixels are 0 and others are 1.
• A tutorial Jupyter notebook.

Use

git clone https://github.com/reiserm/Xana_example.git
tar xzf ./Xana_example/xpcs_data.tgz

to download and unpack the data.