Metadata-Version: 2.1
Name: Xana
Version: 0.6.6
Summary: Analysis software for XPCS, XSVS and SAXS data.
Home-page: https://github.com/reiserm/Xana
Author: Mario Reiser
Author-email: mario.mkel@gmail.com
License: MIT
Download-URL: https://github.com/reiserm/Xana/archive/v0.6.6.tar.gz
Keywords: data analysis,XPCS,XSVS,SAXS
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >= 3.6
Description-Content-Type: text/markdown
Requires-Dist: corner (>=2.0)
Requires-Dist: emcee (>=3.0)
Requires-Dist: h5py (>=2.0)
Requires-Dist: hdf5plugin
Requires-Dist: ipywidgets
Requires-Dist: lmfit (>=1.0)
Requires-Dist: matplotlib
Requires-Dist: numpy (>=1.19)
Requires-Dist: pandas (>=1.0)
Requires-Dist: pyfai (>=0.19)
Requires-Dist: seaborn
Requires-Dist: cython
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: nbval ; extra == 'test'

[![Tests](https://github.com/reiserm/Xana/workflows/Tests/badge.svg)](https://github.com/reiserm/Xana//actions?query=workflow%3ATests)
[![Codecov](https://codecov.io/gh/reiserm/Xana/branch/master/graph/badge.svg)](https://codecov.io/gh/reiserm/Xana)

# Documentation

The documentation can be found on Read the Docs under this [link](https://xana.readthedocs.io/en/latest/index.html).

# Install Xana

A Fortran compiler and `f2py` (now part of `numpy`) are required build python
modules from fortran routines during installation. If the installation fails due
to a missing compiler see point 3.

1. Install Xana using pip:
   ```sh
   pip install Xana
   ```

2. Install most recent Xana version from GitHub:
   Download (clone) the repository and install Xana.
   ```sh
   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:
   ```sh
   pip install git+https://github.com/reiserm/Xana.git
   ```


3. If a Fortran compiler is not already installed, try
   * Linux: `apt install gfortran`
   * MacOSX: `brew install gcc`
   * On Windows it is a little more complicated. A possible way to install a
     FORTRAN compiler is shown
     [link1](https://www.scivision.co/windows-gcc-gfortran-cmake-make-install/)
     or
     [link2](https://www.scivision.dev/f2py-running-fortran-code-in-python-on-windows/).

4. Additional remarks on the installation on OSX:

   * If installing Xana fails, it might help to unset the following environment
     variables: `unset LDFLAGS` and `unset SHELL` then `pip install Xana`.

# Example Data

An example XPCS dataset can be downloaded from
[Xana_example](https://github.com/reiserm/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
```sh
git clone https://github.com/reiserm/Xana_example.git
tar xzf ./Xana_example/xpcs_data.tgz
```
to download and unpack the data.


