Skip to content

Developer Guide

nxi edited this page May 1, 2023 · 9 revisions

What is Gumtree ?

Gumtree is a software suite for managing large scale scientific instruments. Its primary roles are:

  • Controls and monitors an instrument system
  • Plans and executes experiments on an instrument
  • Retrieves and displays experiment data from the system
  • Reduces and analyses live or archived experiment data

Gumtree runs in two forms. Firstly, Gumtree Workbench is a desktop application that provides graphical user interface for users to interact with a particular instrument. The workbench can be run on multiple operating system, including Windows, Linux and OS X. Secondly, Gumtree Server is a headless application that provides access to an instrument via browsers and mobile devices.

Each Gumtree application is built on an application framework, called the Gumtree Framework. The goal of this framework is to provide developers with solid building blocks for creating high quality scientific applications. Gumtree is an open source project, and can be distributed freely under the [Eclipse Public License (EPL v1.0)] (http://www.eclipse.org/legal/epl-v10.html.)

About This Guide

Gumtree Developer Guide is a definitive reference for people who develop Gumtree based applications. This book is split into the following parts:

Part I - Overview

A glance of the Gumtree project, design and architecture

Part II - Programming Fundamentals

Basic concepts for developing applications with Gumtree

Part III - Gumtree Framework

In depth coverage of the Gumtree application framework

Part IV - Bragg Extensions

Details on supported Bragg Institute instruments

Part V - Advanced Topics

Advanced topics on build system and software maintenance

Clone this wiki locally