Skip to content

IntegratedBreedingPlatform/Workbench

Repository files navigation

Workbench

Overview

Workbench is the front-end for the Breeding Management System developed by Leafnode (Efficio, DigitalLabs) for the Generation Challenge Programme. This contains the UI that provides access to various tools and applications for the breeders (both native Windows and browser based apps).

Sub-modules under Workbench contain the following:

  1. Dashboard and Program Summary
  2. Administration/Program Management tools
  • Program Locations
  • Program Methods
  • Program Creation and Deletion
  • Local Databases backup and restore
  • Custom User Tools (Alpha)
  1. Statistical Analysis Tools frontend for Breeding View
  • Single Site Analysis
  • Multi Site Analysis
  • Meta Analysis for multi-variate
  1. Workflows
  • Marker Assisted Recurring Selection (MARS)
  • Conventional Breeding (CB)
  • Marker Assisted Selection (MAS)
  • Marker Assisted Backcrossing (MABC)
  1. Ontology Browser

Checkout the source code

The project is stored in the GIT repository hosted at github.com. The URL for the repository is:

https://github.com/IntegratedBreedingPlatform/Workbench

Build Dependencies to other projects

Workbench is dependent on Middleware and Commons. See Commons and Middleware for build instructions on those modules.

Prerequisites

For successful integration with the native tools and the apps, you need to have the crop databases from DBScripts.

To Build

You need Maven to build the project.

Configuration files are found in BMSConfig. You will need to set up your own configuration files in this project.

To build using a specific configuration, run the following:

mvn clean install -DenvConfig=dev-config-dir -DskipTests  

where dev-config-dir is the configuration specific to your build.

-DskipTests is optional, if you want to run unit-tests see To Run Tests section.

To Run Tests

To run JUnit tests using the command line, issue the following commands in the top level directory:

  1. To run all tests:
    mvn clean test
  2. To run a specific test class:
    mvn clean test -Dtest=TestClassName
  3. To run a specific test function:
    mvn clean test -Dtest=TestClassName#testFunctionName

You need to specify the database to connect to in your BMSConfig files.

All JUnit test suites require the rice database, except for GenotypicDataManager that uses the groundnut crop in testing.

Similar to building Workbench, add the -DenvConfig parameter to use a specific configuration.

To run JUnit tests using Eclipse, right-click on the specific JUnit test suite the Workbench project, select Run As --> JUnit test.

Developer guide and IDE setup

See the Setting Up Development Environment documentation.

For information on front end development in Workbench, see the README.md in src/main/web.