Skip to content

An open, platform-independent software toolkit for storage and interpretation of sequence data, implemented in Java.

Notifications You must be signed in to change notification settings

giffordlabcvr/gluetools

Repository files navigation

GLUE

Description

GLUE (Genes Linked by Underlying Evolution) is a data-centric bioinformatics environment for virus sequence data, with a focus on variation, evolution and sequence interpretation.

You can learn more about it on the GLUE web site: http://tools.glue.cvr.ac.uk

Build instructions

NOTE: The vast majority of GLUE users probably do not need to build GLUE from source, and should install the binary distribution.

You can find detailed instructions on how to install GLUE from its binary distribution here: http://tools.glue.cvr.ac.uk/#/installation.

Building from source is only required if you intend to fix bugs, develop new GLUE features, or understand in detail how GLUE works.

In order to build GLUE you will need the Java 1.8 SDK and Gradle 4.10.2. The build script may work with other Gradle versions but this has not been tested. You can download Gradle 4.10.2 here: https://services.gradle.org/distributions/.

Build the GLUE engine jar by running gradle jar in the gluetools-core directory:

$ cd gluetools/gluetools-core/
$ gradle jar
:gluetools-core:compileJava
:gluetools-core:processResources
:gluetools-core:classes
:gluetools-core:jar

BUILD SUCCESSFUL

Total time: 10.247 secs

This will create a new jar file in gluetools-core/build/libs.

Please contact the team if you are interested in building / running the web server version of GLUE.

Development environment

We suggest importing the gluetools-core project into Eclipse 4.4 or later for development.

Contact

For questions, issues, or feedback, please contact us at [email protected] or open an issue on the GitHub repository.

Contributing

The GLUE team is very open to new commands and modules contributed by the community. It is probably worth raising any ideas you have with the team before embarking on development. Then we can discuss the design, and other aspects such as whether the required functionality belongs in the GLUE engine or if it can for example be introduced as project-specific scripting.

Feel free to put forward any such ideas on the GLUE support forum.

If contributing to GLUE, please review our Contribution Guidelines.

Contributor Covenant

Credits

The GLUE software was written by Josh Singer. The copyright is held by the University of Glasgow.

License

The project is licensed under the GNU Affero General Public License v. 3.0