Instrument Data Wizard

A metadata editor for files being ingested into MyTardis. Written with PySide6 and PyYAML.

Folder structure

    ime - Namespace for the package
    - ui - Qt UI files and generated PyQt Python files
    - widgets - Python code for individual custom widgets
    - tests - test suite for the project. Each test file has to start with test_.
    resources - Assets used in the UI.
    docs - user and developer documentation.
    scripts - scripts used for devlopment
    dist - generated executable.

Set up for development

Your device needs Java installed for the automated metadata extraction feature to work. Please ensure a Java JDK is installed on your system, such as the Adoptium Java JDK.

This project uses poetry. Set up Poetry, then run:

poetry install
poetry run python -m app

This will install all the project dependencies, then run the app in the Python virtual environment created by poetry.

If you need to run a command in the created virtual environment, you need to prepend the command with poetry run. Or, you can run poetry shell to spawn a shell with the virtual environment activated. This means all subsequent commands will be run in the virtual environment.

Set up Poetry, and run:

poetry install
poetry shell # This activates the virtual envrionment
python -m app

UI files

You can automate the generation of PySide6 UI Python files from .ui files by running:

./scripts/uic.py

The script will watch .ui files and regenerate Python files when changed.

Adding graphics

If you need to include graphics and images, you need to add them into the resource file (default.qrc) using Qt Designer. Then, run:

./scripts/rcc.sh

The script will run pyside6-rcc and store the generated Python resource file in ime/default_qrc.py.

Tests

This project uses Pytest. Run tests using:

poetry run pytest

Documentation

This project uses Sphinx to generate user and developer documentation. Run:

cd docs
poetry run make html

The resulting HTML documentation is available in the docs/_build/html directory.

Generating executables

This project uses pyinstaller to generate a compiled executable. To use, run:

poetry run pyinstaller pyinstaller.spec