Skip to content

neutrons/quicknxs

Repository files navigation

Build Status Test Pipeline Documentation Status codecov

QuickNXS

This app is a frontend for Magnetic Reflectivity Reduction.

Install

Install the development environment

conda env create -f environment.yml
activate quicknxs

Install QuickNXS

Install via source

python -m pip install -e .

This installs the code in editable mode.

Build the wheel

Once QuickNXS is installed

python -m build --no-isolation --wheel

now you can install QuickNXS via the generated wheel on other system

python3 -m pip install quicknxs*.whl

Run

To launch the QuickNXS GUI, run the following command:

quicknxs-gui

When trying to run the GUI, you may see the following error:

GLib-GIO-ERROR **: 13:35:06.773: Settings schema 'org.gnome.settings-daemon.plugins.xsettings' does not contain a key named 'antialiasing'

In this case, try setting the GDK_BACKEND environment variable to x11 before running the GUI:

GDK_BACKEND=x11 quicknxs-gui

Test

In order to run the tests, you will need to have cloned the test data submodule, which requires git-lfs to be installed. Once you have git-lfs installed, you can clone the submodule with the following command:

git submodule update --init --recursive

Then you can run the tests with the following command:

pytest