mlgidGUI - an annotation program for 2D scattering data

mlgidGUI - an annotation program for 2D scattering data - Published in JOSS (2025)

https://github.com/mlgid-project/mlgidgui

Science Score: 93.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 13 DOI reference(s) in README and JOSS metadata
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Last synced: 3 months ago · JSON representation

Repository

mlgidGUI - an annotation program for 2D scattering data

Basic Info

Host: GitHub
Owner: mlgid-project
License: gpl-3.0
Language: Python
Default Branch: main
Homepage:
Size: 29.5 MB

Statistics

Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Releases: 9

Created 12 months ago · Last pushed 4 months ago

Metadata Files

Readme Contributing License Code of conduct

mlgidGUI

Logo of mlgidGUI

Project summary

mlgidGUI is a graphical tool for the analysis and annotation of 2D scattering data e.g. Grazing-Incidence Wide-Angle X-ray Scattering (GIWAXS). The resulting datasets can be used for training and testing ML models or further manual analysis. mlgidGUI is well suited for the annotation of 2D diffraction images with radial symmetry. In particular, it focuses on grazing-incidence wide-angle scattering data analysis and its specific needs.

Installation

Recommended: Precompiled AppImage or EXE

Readily compiled packages for the x64 architecture with Windows and Unix are available at the releases page: https://github.com/mlgid-project/mlgidGUI/releases

To run the program on Windows simply double click on the file and ignore the security warnings.

Follow these instructions to run the AppImage: https://docs.appimage.org/introduction/quickstart.html

Alternative: Installation with conda

Install miniconda https://www.anaconda.com/download/success#miniconda
Create environment conda create -n mlgidGUI python=3.12 pip
Activate environment conda activate mlgidGUI

Clone with git:

git clone https://github.com/mlgid-project/mlgidGUI.git

cd ./mlgidGUI

pip install ./

python3 main.py

Alternative: Installation from PyPI

pip install mlgidGUI * Apply a Patch to pyqtgraph

pip install git+https://github.com/pyqtgraph/pyqtgraph.git@6eb0bf1a928c3e8fef332bbebe8a9da3be0ab19a

Usage

Import images or HDF5 files into the program, select an image in the Project Manager and begin labeling. To add annotations, hold Ctrl + Alt, then click, hold, and drag the mouse over the image, similar to using a shape-drawing tool. The key combination Ctrl + H can be used to hide the annotations. The annotated data can be exported as PASCAL-VOC dataset or as an HDF5 file.

We added a CIF file, a GIWAXS image, and an HDF5 file in the docs\example_files folder to provide the user with examples.
For a short demonstration of the program usage, please refer to the Workflow section.
For a detailed guidance, please refer to the Documentation section

Papers

This project is part of our broader efforts to improve and automate GIWAXS analysis. Below is a list of related papers.

ML-based peak detection and structure refinement

Tracking perovskite crystallization via deep learning-based feature detection on 2D X-ray scattering data

V. Starostin, V. Munteanu, A. Greco, E. Kneschaurek, A. Pleli, F. Bertram, A. Gerlach, A. Hinderhofer, and F. Schreiber. npj Comput Mater 8, 101 (2022) https://doi.org/10.1038/s41524-022-00778-8

Deployment at synchrotron facilities for real-time analysis

End-to-end deep learning pipeline for real-time processing of surface scattering data at synchrotron facilities

V. Starostin, L. Pithan, A. Greco, V. Munteanu, A. Gerlach, A. Hinderhofer, and F. Schreiber. Synchrotron Radiation News, 35:4, 21-27 (2022) https://doi.org/10.1080/08940886.2022.2112499

Benchmarking peak detection

Benchmarking deep learning for automated peak detection on GIWAXS data

C. Vlter, V. Starostin, D. Lapkin, V. Munteanu, M. Romodin, M. Hylinski, A. Gerlach, A. Hinderhofer, F. Schreiber. Journal of Applied Crystallography (2025) accepted https://doi.org/10.1107/S1600576725000974

Owner

Name: mlgid
Login: mlgid-project
Kind: organization

Repositories: 1
Profile: https://github.com/mlgid-project

JOSS Publication

mlgidGUI - an annotation program for 2D scattering data

Published

November 09, 2025

DOI

10.21105/joss.08499

Volume 10, Issue 115, Page 8499