Hyspecppt

Tool that enables users to analyze polarized neutron experiments on powder and single crystal samples using the HYSPEC instrument.

Installation Process

Create and activate a virtual environment with Pixi.Prerequisites: Pixi installation e.g. for Linux:

curl -fsSL https://pixi.sh/install.sh | sh

Download the repository. Setup/Update the environment

pixi install

Enter the environment

pixi shell

Start the tool

hyspecppt

For Contributors

Development/Deployment

---

Any change to pyproject.toml, e.g. new dependencies, requires updating the pixi.lock file and including it in the commit.

pixi.lock

Conda Package Testing

The following packages are required to exist in the environment, in order to test the hyspectppt conda package with the existing tests:

pytest
pytest-qt
pytest-mock
pytest-xvfb

After they are installed run

pytest

Documentation Build locally

Enter the documentation directory

cd docs\

Build the doc locally into "build/html" folder:

pixi run sphinx-build -T -b html docs/source build/html

Documentation hyspecppt.readthedocs.io