Yamcs Studio

Binary Releases

https://github.com/yamcs/yamcs-studio/releases/

Note to macOS users: Binaries are not signed, nor notarized. Bypass Gatekeeper checks using:

sudo xattr -rds com.apple.quarantine ~/Downloads/Yamcs\ Studio.app

Build Documentation

cd docs/
make html

After building, users may access documentation at docs/_build/html/index.html

End-User Documentation

https://docs.yamcs.org/yamcs-studio/

Building from Source

Headless Build

mvn clean package -Dtycho.localArtifacts=ignore

Eclipse Development

Yamcs Studio is developed via ‘Eclipse for RCP and RAP developers’. The advantage over the headless build is that Eclipse can launch snapshot copies of Yamcs Studio in seconds instead of minutes. Follow these steps to prepare your Eclipse development environment:

• Ensure you successfully ran the headless build first, because this will generate artefacts needed in the Eclipse build.

• Go to Preferences > Maven > Errors/Warnings, select Warning or Ignore (you choose) for the setting Plugin execution not covered by lifecycle configuration.

• Under Preferences > Maven > Discovery, click on the Open Catalog button and install the Tycho Configurator from there. This plugin will add support for Tycho artefacts to the integrated Maven build cycle.

• Import the Yamcs Studio maven projects into the workspace by right clicking in the navigator and choosing Import > Maven > Existing Maven Projects. Follow the on-screen instructions.

• Open the platform.target file found in repository root. Click the upper right link Set as target platform. This operation may take a while, as it will attempt to resolve and download third-party dependencies.

• All error signs should now be resolved. If not, try right-clicking the yamcs-studio project and choose Maven > Update Project Configuration.

• Open the org.yamcs.studio.editor.product/yamcs-studio.product file.

• Click Synchronize followed by Launch an Eclipse Application. NOTE: Eclipse might complain about line 45 of yamcs-studio/releng/org.yamcs.studio.editor/plugin.xml.

If it does, comment it out as such:

        name="preferenceCustomization">
  </property-->

Compile it from source(Tested on Ubuntu 18.04.5 LTS)

1. maven must be set to JAVA 11: export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64/

NOTE: Configuring JAVA_HOME export will only make the setting active for the current shell session. If you open a new shell, this setting will be discarded. You may add this command to your .bashrc script to enforce it on every shell session.

2. To ensure maven is configured correctly: mvn --version:

       Java version: 11.0.9.1, vendor: Ubuntu, runtime: /usr/lib/jvm/java-11-openjdk-amd64
       Default locale: en_US, platform encoding: UTF-8
       OS name: "linux", version: "5.4.0-65-generic", arch: "amd64", family: "unix"

The important part here is Java 11; this means maven is configured to use JAVA11. If it is anything lower than that, then yamcs-studio will not build.

3. Build Yamcs Studio:

mvn clean package -DskipTests

This will take a while.

4. Untar and install: ``` cd org.yamcs.studio.editor.product/target/products/ mkdir /opt/yamcs-studio tar -xzf yamcs-studio-1.7.0-SNAPSHOT-linux.gtk.x86_64.tar.gz –strip-components=1 -C “/opt/yamcs-studio/“

That's it! YAMCS Studio is installed in `/opt/yamcs-studio`.

**NOTE**: If, for some reason you are messing with dependencies and maven starts failing, build with the following command:

mvn dependency:purge-local-repository package -DskipTests -DreResolve=false