Skip to content

Installation

Hal Clark edited this page May 2, 2023 · 5 revisions

Quick Start (Linux x86_64)

Download the latest AppImage artifact from the continuous integration server here or via:

 $>  curl https://halclark.ca/ci/DICOMautomaton-latest-x86_64.AppImage > dicomautomaton_dispatcher
 $>  chmod 777 dicomautomaton_dispatcher
 $>  ./dicomautomaton_dispatcher -h

This artifact corresponds to the latest successful build on https://halclark.ca/ci/. Please confirm the checksum. Installation is not necessary, but the file can be renamed and installed in a standard location for convenience (e.g., /usr/bin/).

Notes and caveats:

  • This is not an official release. It may be lacking functionality, and is almost certainly not optimized.

  • The CI build environment is currently based on Debian oldstable. Attempting to run on systems with older glibcs will likely fail.

  • AppImages require FUSE support, so running in Docker will not work. However, AppImages can be extracted and run without FUSE via:

    $> ./DICOMautomaton-x86_64.AppImage --appimage-extract
    $> ./squashfs-root/usr/bin/dicomautomaton_dispatcher -h
    
  • The CI AppImage currently expects graphical components to be available on the host system. It will fail if libGL, freetype, or libstdc++ libraries are either incompatible or missing.

  • See https://gitlab.com/hdeanclark/DICOMautomaton or https://github.com/hdclark/DICOMautomaton for sources and build scripts.

Quick Start (Windows x86_64)

Download the latest Windows executable continuous integration artifacts here

After unpacking the zip archive, locate binary usr/bin/dicomautomaton_dispatcher.exe which provides a graphical interface.

Notes and caveats:

  • This is not an official release. It may be lacking functionality, and is almost certainly not optimized.

  • An OpenGL DLL is provided by default in case your system lacks appropriate drivers. This is more portable, since it emulates OpenGL in software, but degrades performance significantly. Remove (or rename) this DLL if your system offers OpenGL hardware-accelerated drivers.

Quick Start (MacOS x86_64)

Currently DICOMautomaton has partial, but limited support for MacOS. Builds have reduced functionality due to platform development limitations and lack of hardware. There is currently no automated testing performed. Docker or the web interface might offer reasonable workarounds (see below).

Download the latest MacOS executable continuous integration artifacts here. Please confirm the checksum.

After downloading and unpacking the tar archive, you can run binaries via:

$>  chmod 777 artifacts/bin/dicomautomaton_dispatcher
$>  ./artifacts/bin/dicomautomaton_dispatcher -h

Please create an issue on the GitHub project page here if you encounter issues.

Notes and caveats:

Quick Start with Containerization

Docker containers package up a complete build environment and provide a way for non-Linux systems to compile locally.

See containers.

Compiling

Continuous integration does not build all functionality. Building DICOMautomaton yourself will provide the most functionality.

Currently, a Linux system is required to build DICOMautomaton. Windows binaries must be cross-compiled from a Linux system.

See compiling.

Continuous Integration

Some Arm architectures and build variants are routinely built as part of continuous integration. These can be used, for example, to run DICOMautomaton on Android devices.

See continuous integration.

Portable Binaries

It is possible to build Linux binaries that behave similar to AppImages, but do not require FUSE support.

See portable binaries.

Other Build Options

It's possible to build DICOMautomaton using Nix, and there are additional 'exotic' build possibilities.

See other build options.