Skip to content
This repository has been archived by the owner on Nov 7, 2024. It is now read-only.
Matthew D Jones edited this page Feb 14, 2020 · 34 revisions

Welcome to the NeXus Constructor wiki!

The NeXus Constructor is a GUI application for creating/visualising NeXus files containing geometry information. It contains a 3D view of space in which components will be displayed according to their geometry information as well as transformations and pixel data.

The program uses the Qt Widgets approach through the 'Qt for Python' (aka 'PySide2') bindings. It is an official set of bindings produced by Qt. Unfortunately documentation for it isn't easy to come by so we hope this wiki can help.

This wiki consists of three main sections:

  • Developer Notes - a resource that aims to compile and explain noteworthy features (or quirks) of the program so that developers know what they're working with. Consult this to get a general view of the program. Contains some QML, some Python, some QML + Python, and some things that are unrelated to both QML and Python.
  • QML Guide - a guide/tips and tricks resource for "pure" QML. Consult this if you are trying to do something that is purely concerned with the views and has no interaction with Python.
  • Qt for Python Guide - a tutorial/tips and tricks resource for using QML with Python. Consult this if the issue you are addressing with involves (or might be benefited by) the views communicating with Python.

NeXus definitions update

The NeXus definitions are included as a git subtree. They can be updated by running the following command:

git subtree pull --prefix definitions git@github.com:nexusformat/definitions.git master --squash