Requirements - giffordlabcvr/Hepadnaviridae-GLUE GitHub Wiki

GLUE can be installed Natively (i.e. running directly on your system) or in a Docker container.

Native Install

The Native Install option is more complex. It requires Oracle Java 1.8.0 (or later) and set up of a specific named database within MySQL 5.6 (or later).

Several GLUE functions also require integration of external software including BLAST+, MAFFT & RAxML. Each of these will need to be installed separately if installing GLUE natively.

---

Docker Install

The Docker Container option requires only installation of the Docker Engine. However, it will require the user to learn some core basic concepts if unfamiliar with the Docker environment.

Docker is an open-source platform that automates the deployment of applications within lightweight, portable containers. These containers package an application along with all its dependencies, libraries, and configurations, ensuring that it can run consistently across different environments, from local machines to cloud servers, without compatibility issues. This makes Docker especially useful for simplifying software installation and enhancing reproducibility.

---

Example Project

If using GLUE for the first time, it is also recommended to build the example project to become familiar with the GLUE environment and the structure of data within a project. Details of how to access and build the example project can be found in the GLUE User Guide:

---