Skip to content

Commit

Permalink
Merge pull request #17 from 3D-e-Chem/knime51
Browse files Browse the repository at this point in the history
KNIME 5.1 support
  • Loading branch information
sverhoeven authored Nov 22, 2023
2 parents 1ff9c5d + 50a69a6 commit dde6a16
Show file tree
Hide file tree
Showing 28 changed files with 477 additions and 109 deletions.
61 changes: 61 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# This workflow will build a Java project with Maven
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven

name: Java CI with Maven

on:
push:
branches:
- master
pull_request:
types: [opened, synchronize, reopened]

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
shell: bash -l {0}
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: 17
distribution: 'temurin'
cache: maven
- name: Build and analyze
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
run: xvfb-run mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=3D-e-Chem_knime-plants
build-windows:
runs-on: windows-latest
steps:
- uses: actions/checkout@v3
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: 17
distribution: 'temurin'
cache: maven
- name: Build
run: mvn -B package
- name: Test executable
run: bin.windows/src/main/resources/bin/PLANTS
build-macos:
runs-on: macos-latest
steps:
- uses: actions/checkout@v3
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: 17
distribution: 'temurin'
cache: maven
- name: Build
run: mvn package
- name: Test executable
run: bin.macosx/src/main/resources/bin/PLANTS
8 changes: 8 additions & 0 deletions .mvn/extensions.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<extensions>
<extension>
<groupId>org.eclipse.tycho</groupId>
<artifactId>tycho-build</artifactId>
<version>2.7.5</version>
</extension>
</extensions>
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ The file is formatted as described on http://keepachangelog.com/.

## [Unreleased]

## [0.3.6] 2023-11-22

### Changes

- Requires KNIME 5.1

## [0.3.5] 2019-06-27

### Changes
Expand Down
2 changes: 0 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ authors:
- given-names: Chris
family-names: de Graaf
affiliation: Vrije Universiteit Amsterdam
version: v0.3.5
date-released: 2019-06-27
repository-code: https://github.com/3D-e-Chem/knime-plants
license: Apache-2.0
references:
Expand Down
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,18 @@

KNIME nodes to configure, run and analyze PLANTS protein-ligand docking

PLANTS homepage at http://www.mnf.uni-tuebingen.de/fachbereiche/pharmazie-und-biochemie/pharmazie/pharmazeutische-chemie/pd-dr-t-exner/research/plants.html
PLANTS homepage at http://www.tcd.uni-konstanz.de/research/plants.php

[![Build Status Linux & OS X ](https://travis-ci.org/3D-e-Chem/knime-plants.svg?branch=master)](https://travis-ci.org/3D-e-Chem/knime-plants)
[![Build status Windows ](https://ci.appveyor.com/api/projects/status/wnwuac96jd7v76ri?svg=true)](https://ci.appveyor.com/project/3D-e-Chem/knime-plants)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nl.esciencecenter.e3dchem.knime.plants%3Anl.esciencecenter.e3dchem.knime.plants&metric=alert_status)](https://sonarcloud.io/dashboard?id=nl.esciencecenter.e3dchem.knime.plants%3Anl.esciencecenter.e3dchem.knime.plants)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=nl.esciencecenter.e3dchem.knime.plants%3Anl.esciencecenter.e3dchem.knime.plants&metric=coverage)](https://sonarcloud.io/dashboard?id=nl.esciencecenter.e3dchem.knime.plants%3Anl.esciencecenter.e3dchem.knime.plants)
[![Java CI with Maven](https://github.com/3D-e-Chem/knime-plants/actions/workflows/build.yml/badge.svg)](https://github.com/3D-e-Chem/knime-plants/actions/workflows/build.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=3D-e-Chem_knime-plants&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=3D-e-Chem_knime-plants)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=3D-e-Chem_knime-plants&metric=coverage)](https://sonarcloud.io/summary/new_code?id=3D-e-Chem_knime-plants)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.997272.svg)](https://doi.org/10.5281/zenodo.997272)

This project uses [Eclipse Tycho](https://www.eclipse.org/tycho/) to perform build steps.

# License

Included in PLANTS nodes plugin is the PLANTS executable with academic license (http://www.mnf.uni-tuebingen.de/fachbereiche/pharmazie-und-biochemie/pharmazie/pharmazeutische-chemie/pd-dr-t-exner/research/plants.html).
Included in PLANTS nodes plugin is the PLANTS executable with academic license (http://www.tcd.uni-konstanz.de/research/plants.php).
When installing the plugin you have to accept this license agreement, you agree to use the included PLANTS executable only for academic usage.
To use these nodes in a commercial manner you need to acquire a valid license yourself and configure the PLANTS node to use the commercial executable.

Expand All @@ -24,13 +23,13 @@ The PLANTS KNIME nodes themselves have the Apache 2.0 license.

Requirements:

* KNIME, https://www.knime.org, version 4.0 or higher
* KNIME, https://www.knime.org, version 5.1 or higher

Steps to get the PLANTS KNIME node inside KNIME:

1. Goto Help > Install new software ... menu
2. Press add button
3. Fill text fields with the `https://3d-e-chem.github.io/updates` update site url.
3. Fill text fields with the `https://3d-e-chem.github.io/updates/5.1` update site url.
4. Select --all sites-- in `work with` pulldown
5. Select the node
6. Install software
Expand Down Expand Up @@ -59,11 +58,11 @@ The update site can be used to perform a local installation.

Steps to get development environment setup based on https://github.com/knime/knime-sdk-setup#sdk-setup:

1. Install Java 8
2. Install Eclipse for [RCP and RAP developers](https://www.eclipse.org/downloads/packages/release/2018-12/r/eclipse-ide-rcp-and-rap-developers)
3. Configure Java 8 inside Eclipse Window > Preferences > Java > Installed JREs
1. Install Java 17
2. Install Eclipse for [RCP and RAP developers](https://www.eclipse.org/downloads/packages/installer)
3. Configure Java 17 inside Eclipse Window > Preferences > Java > Installed JREs
4. Import this repo as an Existing Maven project
5. Activate target platform by going to Window > Preferences > Plug-in Development > Target Platform and check the `KNIME Analytics Platform (4.0) - nl.esciencecenter.e3dchem.knime.plants.targetplatform/KNIME-AP-4.0.target` target definition.
5. Activate target platform by going to Window > Preferences > Plug-in Development > Target Platform and check the `KNIME Analytics Platform (5.1) - nl.esciencecenter.e3dchem.knime.plants.targetplatform/KNIME-AP-5.1.target` target definition.

During import the Tycho Eclipse providers must be installed.

Expand Down
1 change: 1 addition & 0 deletions bin.feature/build.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
bin.includes = feature.xml
Loading

0 comments on commit dde6a16

Please sign in to comment.