NeXus Constructor v2.0.0

News

A major overhaul of the NeXus constructor has been done in 2021 and 2022.
The most impactful changes that the user will directly notice are following:

• Changes to NeXus tree structure and tree view. It is now possible to build any arbitrary NeXus structure by adding and editing groups, components, transformations and file writer modules.
• Upgrade from PySide2 to PySide6.
• Overall improvements to the graphical user interface such as component highlights in 3D view, colors, camera settings and many more.
• Countless bug fixes.

What's Changed

• Fixing windows-specific transformation view UI issue by @rerpha in #694
• 662 - fixing array attributes not being set correctly by @rerpha in #691
• Adding general information about purpose of nexus constructor by @rerpha in #698
• #699: Adding "getting started" page by @rerpha in #700
• Make start guide link more prominent in readme by @matthew-d-jones in #704
• Encourage virtual environment usage by @mattclarke in #705
• Fix test file locations by @mattclarke in #706
• Update README.md by @mattclarke in #707
• Removed explicit instructions for interviews by @mattclarke in #713
• Attempting to make nexus-constructor.py work from any directory by @rerpha in #708
• Use streaming-data-types module from pypi by @matthew-d-jones in #725
• Model change part 1: Add component window by @rerpha in #695
• Disabling nexus actions + silx treeview by @rerpha in #696
• 726 shape model change by @rerpha in #735
• 730: transformations model change by @DolicaAkelloEgwel in #738
• 728 Fixing edit component window by @rerpha in #737
• Model change cleanup by @rerpha in #743
• 730: Preserving distance information by @DolicaAkelloEgwel in #742
• 730: Distance change updates Instrument View by @DolicaAkelloEgwel in #746
• Make default translation along z by @matthew-d-jones in #747
• Add flake8 to precommit hook by @matthew-d-jones in #748
• Add more mypy configuratino by @matthew-d-jones in #750
• 730: Transformation magnitudes in UI value spinbox by @DolicaAkelloEgwel in #753
• 754: Restore transformation view tests by @DolicaAkelloEgwel in #755
• 736 pixel data by @DolicaAkelloEgwel in #756
• Get field value fix by @DolicaAkelloEgwel in #759
• 741 use numpy dtypes by @DolicaAkelloEgwel in #761
• 731: Fix attributes by @DolicaAkelloEgwel in #762
• Refactor extract dataset and attribute value types by @matthew-d-jones in #765
• Try using 7zip for archiving on windows by @matthew-d-jones in #766
• Refactor top level of model by @matthew-d-jones in #767
• Add as_dict methods to some model classes by @matthew-d-jones in #770
• 763 chopper shapes by @DolicaAkelloEgwel in #764
• 772: Fix add row by @DolicaAkelloEgwel in #775
• 771: Edited component loses transformations by @DolicaAkelloEgwel in #776
• Reduce dependency on external code by @matthew-d-jones in #777
• #745: Fixing external transformations by @rerpha in #752
• 773: Remove no shape cube when component is edited by @DolicaAkelloEgwel in #780
• 714: Fix zoom to component by @DolicaAkelloEgwel in #781
• Fixing typos in ev42 advanced options by @rerpha in #784
• #769: Storing attribute type information + adding asdict method for attrs by @rerpha in #785
• 782: Load from JSON prototype by @DolicaAkelloEgwel in #788
• Fix freezing app on windows by @matthew-d-jones in #794
• updating to 5.15.0 by @rerpha in #795
• 757: Some work on reading Transformations by @DolicaAkelloEgwel in #792
• 799: JSON component depends on by @DolicaAkelloEgwel in #801
• 800: Read OFF Geometry from JSON by @DolicaAkelloEgwel in #802
• 800: Load cylinder information from JSON by @DolicaAkelloEgwel in #804
• Fix coverage reporting by @rerpha in #812
• Close edit or attrs window when the parent dialog is closed by @rerpha in #806
• Fix for JSON loading warning dialog immediately closing after being shown by @rerpha in #810
• 786 missing as dicts by @rerpha in #793
• 805: Loading JSON pixel data by @DolicaAkelloEgwel in #807
• 814 Fix set_field_value by removing optional dtype and making dtype required by @rerpha in #815
• Use official flake8 precommit hook by @matthew-d-jones in #818
• Extract strings into constants wherever possible, use ValueTypes class by @rerpha in #817
• 813: Pixel mapping loading by @rerpha in #819
• Output forwarder config flatbuffer file by @matthew-d-jones in #822
• Model change cleanup by @rerpha in #820
• 824 json loading fields by @rerpha in #826
• ECDC-2007 Fix linter and macOS build issues by @amues in #828
• Use virtualenv for OSX CI builds by @matthew-d-jones in #831
• Correct transformations by @matthew-d-jones in #830
• 799 json depends on loading by @rerpha in #825
• Update to latest pyside to avoid Mac-based crash by @mattclarke in #838
• Implement saving and loading depends_on chains of transformations by @matthew-d-jones in #834
• changing datatype check to check for integers and not floats by @kmurica in #842
• Correct link to jenkins build badge by @ebadkamil in #845
• Add isort as a pre-commit hook by @ebadkamil in #849
• 843 fix json warning bug by @kmurica in #850
• 722 Show Button labels in ToolBar by @ebadkamil in #847
• Update Getting started README by @ebadkamil in #846
• 717 component edit add confirm window by @kmurica in #848
• 719 Raise buttons which are currently selectable by @ebadkamil in #851
• ECDC-2397: Change toolbar button background color if enabled by @ebadkamil in #853
• ECDC-2448: Add About Window by @ebadkamil in #854
• Ecdc 2395 fix mypy errors by @kmurica in #855
• Updated json structure by @SkyToGround in #856
• Fix minor UI issues by @SkyToGround in #857
• Various minor bug and ui fixes. by @SkyToGround in #858
• ECDC-2406: Remove file writer control functionality. by @ebadkamil in #860
• ECDC-2700_fixing_hdf5_links by @kmurica in #859
• Rearrange json utilities module by @ebadkamil in #865
• Remove size attribute from Dataset by @ebadkamil in #868
• ECDC-2405: if invalid value entered then it is reported on save by @mattclarke in #861
• transformation_type are lower case by @zjttoefs in #869
• ECDC - 2435: Enable live update by @umithardal in #866
• ECDC-2404: Save/Load kafka Stream to/from JSON by @ebadkamil in #864
• revert unexpected transformation inversion by @zjttoefs in #870
• address warnings with python 3.9 by @zjttoefs in #871
• ECDC-2374: Deal with units in transformation by @ebadkamil in #873
• Update figures in getting started guide by @ebadkamil in #874
• ECDC-2680: proposal id placeholder by @mattclarke in #872
• ECDC-2693 load json reimplementation by @kmurica in #862
• ECDC-2678: Can set a title or use placeholder by @mattclarke in #876
• ECDC-2728: Make transformation compatible with new Dataset class by @ebadkamil in #879
• ECDC-2726_remove_old_dataset_class by @kmurica in #878
• Check for scalar values castable to float by @ebadkamil in #880
• Ecdc 2730 disk chopper orientation by @zjttoefs in #881
• ECDC-2735_fix_json_load_error by @kmurica in #884
• ECDC-2722: NXslit Visualisation by @umithardal in #882
• ECDC-2440: Add documentation for streams by @ebadkamil in #885
• fix attributes bug by @kmurica in #887
• ECDC-2697: Allow users to be defined in the GUI by @mattclarke in #886
• ECDC-2725 updating advanced options for streams by @kmurica in #888
• ECDC-2697: add users placeholder by @mattclarke in #889
• ECDC-2725 Enable stream advanced options by @kmurica in #890
• Update NeXus definitions. by @SkyToGround in #891
• ECDC-2435: Tidy up transformation view by @umithardal in #867
• removing unused functions in load json by @kmurica in #892
• ECDC-2738 Remove component list by @kmurica in #895
• ECDC-2723: Visualise neutron source by @ebadkamil in #893
• ECDC-2719 Making ctrl-c work by @kmurica in #896
• ECDC-2737: respect dataset type when writing to JSON by @ebadkamil in #897
• ECDC-2746: Error loading amor json by @kmurica in #898
• ECDC-2724 dimensions to visualize NXsample by @kmurica in #899
• ECDC-2757: Update signature of add_component method in Instrument view by @ebadkamil in #900
• ECDC-2434 Adding name validator to attributes by @kmurica in #901
• ECDC-2731 Create component directly in load json by @kmurica in #902
• ECDC-2710 display groups in treeview by @kmurica in #903
• Remove windows build by @amues in #904
• adding frame for modules by @kmurica in #905
• ECDC-2716 Adding links in new tree model by @kmurica in #907
• ECDC-2772 new model implementation by @kmurica in #908
• ECDC-2783 ADAr stream widget by @kmurica in #911
• Use fileobject to load json by @ebadkamil in #912
• ECDC-2798 Do not automatically add stream module in NXlog by @kmurica in #910
• ECDC-2800: Bug fix in deleting users in configure users table by @ebadkamil in #913
• Live update when spin box changed by @umithardal in #914
• Remove black list from component type by @umithardal in #915
• Ecdc 2729 fix nexus format docs by @SkyToGround in #877
• ECDC-2804 NXdetector bug fix regarding streams by @kmurica in #916
• ECDC-2375 Add sensible default data type for field in nexus class object by @kmurica in #917
• ECDC-2834 Fix tree model view performance by @kmurica in #918
• ECDC-2844 Removing the stream in parent of parent in edit group dialogue by @kmurica in #919
• removing nx_class from enumerator fieldtype by @kmurica in #920
• Ecdc 2850 fix paint method by @SkyToGround in #921
• ECDC-2853: Improving and fixing stream widget editing in tree view by @kmurica in #922
• ECDC-2854 Fix transformation link creation by @kmurica in #923
• fixing target_index when transformation group is selected by @kmurica in #924
• Save the window state. by @SkyToGround in #926
• ECDC-2843 droppable sources by @SkyToGround in #925
• Ecdc 2874 performance improvements by @SkyToGround in #927
• ECDC-2875 Constrict nx class suggestion when editing group by @kmurica in #928
• ECDC-2399 Find linked component by @SkyToGround in #929
• Minor improvement (?) to NXclass selection UI by @SkyToGround in #930
• General bug fixes by @SkyToGround in #931
• ECDC-2403 Pixel ID UI when loading large OFF file by @kmurica in #932
• Various UI improvements by @SkyToGround in #933
• ECDC-2371 Status indicator loading file by @kmurica in #935
• bug_fix_file_validator by @kmurica in #936
• ECDC-2392 UI message when zero vector by @kmurica in #937
• ECDC-2756 Sample placeholder by @kmurica in #939
• bug fix when editing shape in component by @kmurica in #940
• bug fixes geometry by @kmurica in #941
• ECDC-2381 Adding units to pixel grid control by @kmurica in #942
• ECDC-2736 Parameters for NXslit by @kmurica in #943
• refactoring contest.py by @kmurica in #944
• ECDC-2872 Limit writer modules by @SkyToGround in #938
• ECDC-2372 Support colors in off files by @kmurica in #945
• removing unneccesary code by @kmurica in #946
• bug fix, renaming no shape to auto, slit 3d model fix by @kmurica in #949
• some bug fixes before the workshop by @kmurica in #951
• Ecdc 2909 improve shape handling by @kmurica in #952
• Fix some transformation bugs by @kmurica in #953
• fixing attribute issue by @kmurica in #954
• ECDC-2902 Correctly removes child component entities by @kmurica in #955
• removing reference to saving as a nexus file by @kmurica in #956
• Bug fixes workshop feedback by @kmurica in #957
• fix spelling error for file writer by @kmurica in #958
• ECDC-2927 improve loading off files by @kmurica in #959
• Minor_UI_improvements by @kmurica in #960
• ECDC-2385 Stream config fields required by @kmurica in #947
• ECDC-2901: Adding default units to fields when possible by @kmurica in #961
• adding missed units and fixing typos by @kmurica in #962
• ECDC-2960 hs01 schema implementation by @kmurica in #963
• fixed popup bug by @kmurica in #964
• bug fix when editing streams by @kmurica in #965
• Add cancel button to stream widget by @kmurica in #966
• improving cancel button functionality by @kmurica in #967
• ECDC-2972: Adding ev44 schema by @kmurica in #968
• ECDC-2973: Adding placeholder for area detector array size by @kmurica in #969
• ECDC-2872: limit modules in group by @kmurica in #970
• Main window IndexError exception handling by @kmurica in #972
• Fixes factory default for possible streams in group instances by @kmurica in #973
• ECDC-2975 automate html build by @amues in #971
• ECDC-2931: NeXus constructor should not load class documentation from internet by @kmurica in #974
• ECDC-2983: Fixing issues with group description by @kmurica in #975
• ECDC-2984: Added functionality to save JSON files without whitespace by @kmurica in #976
• fixing bug in array data model by @kmurica in #978
• check if parent node exists before removing stream module by @kmurica in #979
• Transformation bug fix by @kmurica in #980
• removing schema validator and its usage in the StreamFieldWidget by @kmurica in #981
• Main window interface improvements by @kmurica in #982
• ECDC-2432: Add required fields in editor for custom components by @kmurica in #983
• Better fix of unittests by @kmurica in #984
• Stream widget validity check by @kmurica in #985
• QFrame bug fix by @kmurica in #987
• ECDC-2373_setting_fixed_locale by @hurvan in #986
• nexus qframe class by @kmurica in #988
• ECDC-3014: fixing issue with collapsing tree by @kmurica in #990
• ECDC-3016: Stream module signal trigger bug by @kmurica in #991
• ECDC-3019: Do not capitalize fw modules by @kmurica in #992
• ECDC-3017: Fixing documentation and name suggestion for stream module groups by @kmurica in #993
• Autocompletion fixes to group name by @kmurica in #995
• ECDC-3015: Resize NXsource by @kmurica in #996
• fixing defaults when streams are used for gap sizes in slits by @kmurica in #997
• Pyside6 upgrade by @kmurica in #998
• ECDC-3039: Show group parent docs at start by @kmurica in #999
• ECDC-3041: Display depends_on in NeXus tree view by @kmurica in #1000
• Render settings by @hurvan in #1001
• Set focus on description when opening add or edit component dialog by @kmurica in #1002
• Ecdc 2979 drag drop groups by @hurvan in #1003
• ECDC-2376: Drag and drop transformations by @kmurica in #1004
• ECDC-2389: Updating manual test script by @kmurica in #1005
• Fixed small bug that caused the program to render removed geometry by @hurvan in #1006
• ECDC-3038: Adding offset to transformations by @kmurica in #1007
• ECDC-2433: Adding view attributes button in main window by @kmurica in #1008
• ECDC-3111: updating getting started by @hurvan in #1009

New Contributors

• @mattclarke made their first contribution in #705
• @amues made their first contribution in #828
• @kmurica made their first contribution in #842
• @ebadkamil made their first contribution in #845
• @zjttoefs made their first contribution in #869
• @umithardal made their first contribution in #866
• @hurvan made their first contribution in #986

Full Changelog: v1.3.0...v2.0.0