Skip to content

Latest commit

 

History

History
115 lines (75 loc) · 4.74 KB

README.md

File metadata and controls

115 lines (75 loc) · 4.74 KB
Raw

KNIME feature for all 3D-e-Chem nodes.

Package DOI

The 3D-e-chem project of the Netherlands eScience Center, VU Medicinal Chemistry, CMBI Radboud University made a set of KNIME nodes listed at https://www.knime.com/3d-e-chem-nodes-for-knime, this repository combines all the nodes into a single feature which can be installed from the community contributions update site.

This project uses Eclipse Tycho to perform build steps.

Installation of 3D-e-Chem KNIME nodes

Requirements:

Steps to get the 3D-e-Chem nodes inside KNIME:

  1. Goto File > Install KNIME extensions ... menu
  2. Expand the KNIME Community nodes - Cheminformatics folder
  3. Select 3D-e-Chem KNIME nodes
  4. Install software
  5. Restart KNIME

Some nodes need Python packages, those nodes have install instructions in their node description and print a warning when attempting to run them without the required Python package.

Setup

Each KNIME node developed in the 3D-e-Chem project has it own Github repository, Eclipse feature and Eclipse plugin.

The update site https://3d-e-chem.github.io/updates/5.1 contains the Eclipse features of all the 3D-e-Chem developed nodes. When using this update site in KNIME, it will list all the nodes by their repository.

This update site https://3d-e-chem.github.io/knime-node-collection contains a single Eclipse feature which combines all the 3D-e-Chem developed nodes. When using this update site in KNIME, it will list a single feature for all 3D-e-Chem nodes.

Cons of using this repo:

  • New nodes need to be tracked in the feature/feature.xml file
  • Each update of a node requires a new release of this repo aswell
  • License is for all nodes together instead of separate license for each node
  • Maintenance overhead of 2 update sites (1. only one 3D-e-Chem nodes feature, 2. set of 3D-e-Chem node features)

Pros of using this repo:

  • Single checkbox to install all 3D-e-Chem nodes
  • Integrated into KNIME Community Contributions update site under KNIME Community nodes - Cheminformatics folder. Users do not need to configure an extra update site.

So to have the latest version of each node you should use https://3d-e-chem.github.io/updates/5.1, but for stable releases use https://3d-e-chem.github.io/knime-node-collection.

Adding a new KNIME node

To include a KNIME node into the 3D-e-Chem KNIME nodes feature, it's plugin(s) and optional 3D-e-Chem dependencies must be added to the feature/feature.xml file. Followed by making a new release, see below.

Adding a new version of a KNIME node

The updated KNIME node can be included in the 3D-e-Chem nodes feature by making a new release, see below.

Build

mvn verify

An Eclipse update site will be made in p2/target/repository repository. The update site can be used to perform a local installation.

Development

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

  1. Install Java 17
  2. Install Eclipse for RCP and RAP developers
  3. Configure Java 17 inside Eclipse Window > Preferences > Java > Installed JREs
  4. Import this repo as an Existing Maven project
  5. Add http://update.knime.org/analytics-platform/5.1 and https://3d-e-chem.github.io/updates/5.1 to list of update sites

During import the Tycho Eclipse providers must be installed.

New release

  1. Make sure the local clone of this repo is up to date using

    git pull

  2. Make sure all included plugins are up to date on https://3d-e-chem.github.io/updates or https://github.com/3D-e-Chem/3D-e-Chem.github.io/tree/master/updates

  3. Learn current version by looking in ./pom.xml file for the <version>x.y.z-SNAPSHOT</version> tag.

  4. Increase version. Increase minor version when KNIME node has been added or removed. Increase patch version when KNIME node has been updated. Use following command to update multiple xml files with the new version.

    mvn org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=<new version>-SNAPSHOT

  5. Commit changes

  6. Update docs/4.3/ directory with new update site using

    mvn install

  7. Stage new files, commit and push changes.

    git add docs/
git commit -a
git push

  8. For major or minor release