SUIT - the Rubin Science Platform Portal Aspect application

Description

The SUIT (Science User Interface and Tools) repository contains applications built on the Firefly Toolkit. It is meant to be used with Firefly.

The principal current application is "suit", otherwise known as the Portal Aspect application, which contains both the Portal search screens and visualization capabilities, and the "slate" endpoint that is used for Python-based image and table visualizations.

Release configuration management

Please see the Rubin Observatory document DMTN-136 for a detailed discussion of release procedures.

The SUIT build process provides for the ability to include in a release of the SUIT source code an explicit statement of the Firefly release (GitHub tag) against which it is to be built.

The philosophy of use of this feature is that suit:master will not use that feature, so that a standard build of the package from the tip of master will by default be performed against the tip of the Firefly default branch (which is dev for Firefly, not main or master). However, in a release branch of suit, the feature will be used to constrain the build to a released version of Firefly, by setting that tag in a firefly.tag.name property in the file config/app.config in the repo. Edits to that file should always be performed in separate commits and not commingled with any code, documentation, or release note changes, so that these commits can rigorously be excluded from merging to suit:master.

Test builds of suit against specific non-release versions of Firefly can be made by creating a suit branch in which the firefly.tag.name property is set appropriately.

Examples:

gradle -Pfirefly.tag.name=release-2022.1.0 firefly:checkoutFirefly

This will checkout Firefly at the given tag release-2022.1.0.

Local Build Instuctions

• Install JDK 8

• Install Gradle 4.x

• Install Node.js 8.x

• Install yarn

  npm install yarn -g
  

• Install HTMLDOC

• Clone firefly, suit, and `suit-onlinehelp' repositories:

   git clone https://github.com/Caltech-IPAC/firefly
   git clone https://github.com/lsst/suit
   git clone https://github.com/lsst/suit-onlinehelp
  

• Switch to the git branch you want to build on. This should be done on all repositories. Refer to https://github.com/Caltech-IPAC/firefly/blob/dev/docs/tags-and-branches.md for firefly branching scheme.

• In a terminal/console/command prompt, enter:

   cd suit
   gradle :suit:warAll