Installation

(Recommended) The Python Package Index

The recommended way of installing MassDash is through the Python Package Index (PyPI). We recommend installing MassDash in its own virtual environment using Anaconda to avoid packaging conflicts.

First create a new environment:

conda create --name=massdash python=3.9
conda activate massdash

Then in the new environment install MassDash.

pip install massdash --upgrade

After installation the GUI can be launched in the Terminal/Anaconda Prompt using

massdash gui

Installation Guides

In depth installation guides can be found below:

1. Windows Installation - Installation guide for Windows

2. Mac Installation - Installation guide for Mac BigSur

3. Ubuntu Installation - Installation guide for Ubuntu

One Click Installation

For those unfamilliar with commandline and only plan on using the GUI, a one click installation is also avaliable. Please see below for current releases.

For a one-click installation, click on the corresponding badge corresponding to your operating system, or visit the latest release page and download the installer for your operating system.

Demo App

To test out MassDash please click here.

Note

The demo app is a simplified version of the MassDash GUI, and does not contain all the features of the full software.

Building from Source

The source code is freely open and accessible on Github at https://github.com/Roestlab/massdash under the BSD-3-Clause license. The package can be installed by cloning and installing from source using pip.

First clone the repository:

git clone git@github.com:Roestlab/massdash.git

Change into the massdash directory

cd massdash

Install using pip

pip install -e .

Docker Image

MassDash is available as a docker image on dockerhub here, ensure you have docker installed on your system, you can then pull the latest image of MassDash.

docker pull ghcr.io/roestlab/massdash:latest