Skip to content

DiamondLightSource/islatu

Repository files navigation

islatu

X-ray reflectometry reduction from Diamond Light Source

codecov Actions Status Documentation Status

Install

This package can be easily installed using pip install islatu.

Installation from source

To install in a fresh environment, first ensure that pip is available. For example, using conda:

conda create --name islatu
conda activate islatu
conda install pip

Assuming that pip is available, installation of the library from source can be done by cloning this repository. Navigate to its directory and use pip to install this package and its dependencies as follows:

python -m pip install . -r requirements.txt

Make sure that your installation is functioning by running pytest.

Documentation

The documentation for this package can be found at https://islatu.readthedocs.io/en/latest/

An example of a typical data reduction workflow can be found at https://islatu.readthedocs.io/en/latest/i07_reflectivity.html

To build the documentation, make sure you have sphinx installed on your system. Go to the docs directory and run

make html