Skip to content

trnielsen/nexus-constructor

 
 

Repository files navigation

License (2-Clause BSD) codecov Build Status Code style: black

NeXus Constructor

Construct NeXus files with instrument geometry information using a GUI.

NeXus Constructor

Currently tested on Windows 10 and CentOS 7, it should also work on other Linux distributions. Currently it does not work on Mac due to a bug in Qt, but we hope to resolve this soon.

Installing dependencies

This project is developed for Python 3.6, so an install of 3.6 or higher is required. https://www.python.org/downloads/

Runtime Python dependencies are listed in requirements.txt at the root of the repository. They can be installed from a terminal by running

pip install -r requirements.txt

Development dependencies

Development dependencies (including all runtime dependencies) can be installed by using the following command:

pip install -r requirements-dev.txt

The black pre-commit hook (installed by pre-commit) requires Python 3.6 or above. You need to once run

pre-commit install

to activate the pre-commit check.

Running the application

Run the python script main.py located in the root of the repository.

Developer Documentation

See the Wiki for developer documentation.

About

Construct NeXus files with instrument geometry information using a GUI

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 92.8%
  • XSLT 2.8%
  • Makefile 1.6%
  • C 0.9%
  • MATLAB 0.5%
  • Batchfile 0.5%
  • Other 0.9%