This is the documentation of DiMA . The newest release is .
This documentation of the development version includes changes that are not released yet. The newest release is .
Install DiMA
DiMA comes as a command-line tool, dima, for analyses, scripts and clusters, and as a
desktop app, dima-gui, for interactive exploration. Both are single programs that need no
other software installed (on Linux the desktop app uses the system’s graphics: X11 or Wayland,
and Vulkan or OpenGL, present on any desktop), published for 64-bit Linux, macOS and Windows on
x86_64 and ARM64 (the desktop app for Windows on x86_64 only) on the
releases page. The commands below use version
1.0.0; replace it with the release you want.
Command line
Section titled “Command line”Choose the build for your system:
| System | Archive (dima-1.0.0-….tar.gz) |
|---|---|
| x86_64 with glibc 2.17 or newer: CentOS/RHEL 7 and later, Rocky and Alma Linux, Ubuntu, Debian, most HPC clusters | x86_64-unknown-linux-gnu |
| ARM64 with glibc 2.28 or newer: RHEL/Rocky 8 and later, Ubuntu 18.10 and later, Debian 10 and later | aarch64-unknown-linux-gnu |
| Any Linux, statically linked: Alpine, minimal containers, very old systems | x86_64-unknown-linux-musl, aarch64-unknown-linux-musl |
ldd --version prints your glibc version. Prefer the gnu builds where they run; the musl
builds are fully static and use the mimalloc allocator to stay fast with many threads.
VERSION=1.0.0TARGET=x86_64-unknown-linux-gnuBASE=https://github.com/ShanWeera/dima-perf/releases/download/v$VERSIONcurl -fLO "$BASE/dima-$VERSION-$TARGET.tar.gz"curl -fLO "$BASE/SHA256SUMS"grep " dima-$VERSION-$TARGET.tar.gz\$" SHA256SUMS | sha256sum --checktar -xzf "dima-$VERSION-$TARGET.tar.gz"mkdir -p ~/.local/bincp "dima-$VERSION-$TARGET/dima" ~/.local/bin/dima --versionNo root access is needed. If dima is not found, add ~/.local/bin to your PATH.
One archive per processor: aarch64-apple-darwin for Apple silicon (M1 and later),
x86_64-apple-darwin for Intel Macs (uname -m prints arm64 or x86_64).
VERSION=1.0.0TARGET=aarch64-apple-darwinBASE=https://github.com/ShanWeera/dima-perf/releases/download/v$VERSIONcurl -fLO "$BASE/dima-$VERSION-$TARGET.tar.gz"curl -fLO "$BASE/SHA256SUMS"grep " dima-$VERSION-$TARGET.tar.gz\$" SHA256SUMS | shasum -a 256 --checktar -xzf "dima-$VERSION-$TARGET.tar.gz"mkdir -p ~/.local/bincp "dima-$VERSION-$TARGET/dima" ~/.local/bin/dima --versionFiles downloaded with curl can run directly. If you downloaded the archive with a web browser,
macOS marks the program as downloaded and refuses to run it because it is not signed; remove the
mark with xattr -d com.apple.quarantine ~/.local/bin/dima.
One archive per processor: x86_64-pc-windows-msvc for most PCs, aarch64-pc-windows-msvc for
ARM64 devices. In PowerShell:
$Version = "1.0.0"$Target = "x86_64-pc-windows-msvc"$Base = "https://github.com/ShanWeera/dima-perf/releases/download/v$Version"Invoke-WebRequest "$Base/dima-$Version-$Target.zip" -OutFile "dima-$Version-$Target.zip"Invoke-WebRequest "$Base/SHA256SUMS" -OutFile SHA256SUMS(Get-FileHash "dima-$Version-$Target.zip" -Algorithm SHA256).Hash.ToLower()Select-String "dima-$Version-$Target.zip" SHA256SUMS # the two hashes must match$Dir = "$env:LOCALAPPDATA\Programs\dima"Expand-Archive "dima-$Version-$Target.zip" -DestinationPath $Dir -Force$UserPath = [Environment]::GetEnvironmentVariable("Path", "User")[Environment]::SetEnvironmentVariable("Path", "$UserPath;$Dir\dima-$Version-$Target", "User")Open a new terminal, then run dima --version.
Each archive also contains shell completions (completions/), the README, the licence and
third-party notices, the changelog and CITATION.cff; the Linux and macOS archives also contain
manual pages (man/man1/). Completions can also
be generated by dima completions bash|zsh|fish|powershell|elvish; for example, for bash:
mkdir -p ~/.local/share/bash-completion/completionsdima completions bash > ~/.local/share/bash-completion/completions/dimaVerify the download
Section titled “Verify the download”Every release lists the SHA-256 checksum of each file in SHA256SUMS (checked above), and
carries a signed build-provenance attestation that ties each file to the release workflow that
built it from the tagged source. With the GitHub CLI:
gh attestation verify dima-1.0.0-x86_64-unknown-linux-gnu.tar.gz --repo ShanWeera/dima-perfBuild from source
Section titled “Build from source”With Rust 1.85 or newer (rustup):
cargo install --locked --git https://github.com/ShanWeera/dima-perf --tag v1.0.0 dima--locked builds with exactly the dependency versions of the release. On Windows, cargo install
does not apply the repository’s build settings, so the program it builds needs the Microsoft
Visual C++ Redistributable; for a self-contained program like the release archives, run
$env:RUSTFLAGS = "-C target-feature=+crt-static" in PowerShell first.
Bioconda and containers
Section titled “Bioconda and containers”A Bioconda recipe is ready and will be submitted; once it is accepted, conda install -c bioconda dima and the matching BioContainers Docker and Apptainer/Singularity images will become the
easiest way to install DiMA on clusters (Grüning, Dale et al. 2018; da Veiga Leprevost et al. 2017; Kurtzer et al. 2017). Until then, use the archives above, which run on any Linux, in containers too.
Desktop app
Section titled “Desktop app”The desktop app needs macOS 11 or newer, Windows 10 or newer on x86_64, or Linux with glibc 2.28 or newer and a graphical session (X11 or Wayland).
| Package | For |
|---|---|
DiMA-1.0.0-x86_64.AppImage, …-aarch64.AppImage | any distribution: make it executable and run it |
dima-gui_1.0.0_x86_64.deb, …_aarch64.deb | Debian, Ubuntu and derivatives |
dima-gui-1.0.0-x86_64-linux.tar.gz, …-aarch64-linux.tar.gz | systems without FUSE, such as many HPC login nodes |
chmod +x DiMA-1.0.0-x86_64.AppImage./DiMA-1.0.0-x86_64.AppImageThe AppImage needs FUSE 2 (libfuse2, called libfuse2t64 on Ubuntu 24.04); without it, run
it with --appimage-extract-and-run, or use the .tar.gz. Install the .deb with
sudo apt install ./dima-gui_1.0.0_x86_64.deb.
DiMA-1.0.0-universal.dmg runs on Apple silicon and Intel Macs. Open it and drag DiMA to
Applications.
The app is not yet signed by an Apple developer certificate, so macOS blocks the first launch. On macOS 15 (Sequoia) and later:
- Open DiMA. macOS reports that it could not verify the app; choose Done.
- Open System Settings ▸ Privacy & Security, scroll to Security, and choose Open Anyway next to the message about DiMA.
- Confirm with your password or Touch ID, and choose Open Anyway once more.
macOS remembers the decision. On earlier versions, Control-click the app, choose Open, then
Open. Alternatively, in Terminal: xattr -dr com.apple.quarantine /Applications/DiMA.app.
DiMA-1.0.0-x86_64.msi installs the app; there is no Windows ARM64 build of the desktop app
yet. The installer is not yet code-signed, so Microsoft Defender SmartScreen may show
“Windows protected your PC”: choose More info, check that the app is DiMA, then
Run anyway.
To build the desktop app from source instead, use Rust 1.95 or newer and replace dima with
dima-gui in the cargo install command above; on Linux this needs the X11, Wayland and Vulkan
development packages (see scripts/ci/install-gui-deps.sh in the repository).
Next: your first analysis.
References
Section titled “References”- da Veiga Leprevost F, Grüning BA, Alves Aflitos S, Röst HL, Uszkoreit J, Barsnes H, Vaudel M, Moreno P, Gatto L, Weber J, Bai M, Jimenez RC, Sachsenberg T, Pfeuffer J, Vera Alvarez R, Griss J, Nesvizhskii AI, Perez-Riverol Y. BioContainers: an open-source and community-driven framework for software standardization. Bioinformatics. 2017;33(16):2580-2582. doi:10.1093/bioinformatics/btx192 ↩︎
- Grüning B, Dale R, Sjödin A, Chapman BA, Rowe J, Tomkins-Tinch CH, Valieris R, Köster J, Bioconda Team. Bioconda: sustainable and comprehensive software distribution for the life sciences. Nature Methods. 2018;15(7):475-476. doi:10.1038/s41592-018-0046-7 ↩︎
- Kurtzer GM, Sochat V, Bauer MW. Singularity: Scientific containers for mobility of compute. PLOS ONE. 2017;12(5):e0177459. doi:10.1371/journal.pone.0177459 ↩︎