jeffersonlab/wave repository overview

⁠WAVE

Web Archive Viewer and Expositor

• Overview⁠
• Quick Start with Compose⁠
• Install⁠
• Configure⁠
• Build⁠
• Develop⁠
• Test⁠
• Release⁠
• Deploy⁠

⁠Overview

Uses myquery⁠ and epics2web⁠ to provide an EPICS⁠ data viewer and analysis tool for the Jefferson Lab archiver MYA as well as plots of live data.

⁠Examples

⁠Features

• Live Chart⁠
• Log Scale⁠
• Crosshair Linked Stacked Charts with Enum Labels⁠
• Multiple Axis Chart with Custom Title, Labels, Series Scaling, and Series Integration⁠

⁠Use Cases

• Power Monitoring⁠
• Cryo Liquid Levels⁠
• Temperature Sensors⁠

⁠Quick Start with Compose

1. Grab project

git clone https://github.com/JeffersonLab/wave
cd wave

1. Launch Compose⁠

docker compose up

1. Use web browser to view channel1 on August 12 2019

localhost/wave?pv=channel1⁠

⁠Install

1. Download Java JDK 17+⁠
2. Download Apache Tomcat 11⁠ (Compiled against Jakarta EE)
3. Download wave.war⁠ and drop it into the Tomcat webapps directory
4. Install myquery⁠ and epics2web⁠.
5. Configure⁠ Tomcat
6. Start Tomcat and navigate your web browser to localhost:8080/wave

⁠Configure

Set the environment variables:

• EPICS_2_WEB_HOST: host (and port) of epics2web
• MYQUERY_HOST: host (and port) of myquery
• MYQUERY_DEFAULT_DEPLOYMENT: default MYA deployment

⁠Build

This project is built with Java 21⁠ (compiled to Java 17 bytecode), and uses the Gradle 9⁠ build tool to automatically download dependencies and build the project from source:

git clone https://github.com/JeffersonLab/wave
cd wave
gradlew build

Note: If you do not already have Gradle installed, it will be installed automatically by the wrapper script included in the source

Note for JLab On-Site Users: Jefferson Lab has an intercepting proxy⁠

⁠Develop

In order to iterate rapidly when making changes it's often useful to run the app directly on the local workstation, perhaps leveraging an IDE. In this scenario run the service dependencies with:

docker compose -f deps.yaml up

⁠Test

Manual tests can be run on a local workstation using:

docker compose -f build.yaml up

⁠Release

1. Bump the version number in the VERSION file and commit and push to GitHub (using Semantic Versioning⁠).
2. The CD⁠ GitHub Action should run automatically invoking:
   • The Create release⁠ GitHub Action to tag the source and create release notes summarizing any pull requests. Edit the release notes to add any missing details. A war file artifact is attached to the release.
   • The Publish docker image⁠ GitHub Action to create a new demo Docker image.

⁠Deploy

The deploy to JLab's epicswebtest is handled automatically via the release workflow.

At JLab this app is found at epicsweb.jlab.org/wave⁠ and internally at epicswebtest.acc.jlab.org/wave⁠. However, those servers are proxies for a clustered set of hosts tomcat1.acc.jlab.org, tomcat2.acc.jlab.org and tomcattest1.acc.jlab.org, tomcattest2.acc.jlab.org respectively. A deploy script is provided on each server to automate wget and deploy. Example:

/opt/tomcat/cd/deploy.sh wave 1.2.3

JLab Internal Docs: builds/epicsweb⁠