Skip to content

References

NORTHTool configuration

Defined in src/nomad_north_gwyddion/north_tools/__init__.py. See the NORTHTool reference for the full field-by-field documentation; the values used here are:

Field Value Meaning
image ghcr.io/fairmat-nfdi/nomad-north-gwyddion:main on main; a version tag (e.g. v0.1.6) once published to PyPI Container image, see Explanation > Why install from PyPI
file_extensions dm4, tif, tiff, wip, wit, spm, ibw Which uploaded files offer this tool
default_url /desktop Opens straight into the desktop session
mount_path /home/jovyan Where the triggering upload is mounted inside the container
path_prefix lab/tree URL path prefix used to address files within the mount
with_path true The launched file's path is passed through to the tool
image_pull_policy Always The image is re-pulled on every launch
privileged false The container does not run with elevated privileges
display_name gwyddion Name shown in NORTH's tool list

Entry point

Registered under [project.entry-points.'nomad.plugin'] in pyproject.toml:

gwyddion = "nomad_north_gwyddion.north_tools:gwyddion"

Base image

The container builds on nomad-north-desktop-base (ghcr.io/fairmat-nfdi/nomad-north-desktop-base), which provides the xfce desktop and noVNC session that NORTH connects to.

Further reading