Installation#
Download#
You can download the latest version of GRAPVEVNE for your platform from github releases and get started straight away:
For Windows users, ensure you have PowerShell, which comes pre-installed as standard on most modern versions of Windows.
GRAPEVNE comes with all of the necessary software to build and launch workflows, including Python, Snakemake and mamba (we use miniforge). To launch workflows outside of GRAPEVNE you will need these dependencies to be installed on your system.
Developer build#
GRAPEVNE comes with a dev container (located in .devcontainer).
For manual builds you will need to have the following dependencies installed:
Python 3.12 and the uv package manager
To build locally, clone the GRAPEVNE repository and run the build script:
git clone git@github.com:kraemer-lab/GRAPEVNE.git -b main
cd GRAPEVNE
./build.sh
Note
On modern MacOS machines with M-Series processors you will likely need to install the
following additional dependencies in order to allow node-canvas to compile. These can
be installed via homebrew:
brew install pkg-config pixman cairo glib pango
or conda:
conda install pkg-config pixman cairo glib pango. No additional installation is
necessary if you are using the dev-container.
This will generate the GRAPEVNE Builder app for your system, located in
an appropriately named subfolder of electron-app/out.