Knowledge Base

Article ID: 1762 - Last Modified: December 18, 2012

How do I install a Knime workflow into Maestro that was provided by a colleague?

A workflow that can be installed in Maestro consists of a Python script, workflowname.py and a directory (folder) named workflowname_dir that contains the rest of the workflow. These will normally be provided in a zip archive. You should first unzip this archive so you have access to the script and the directory.

You can install this workflow for your own use, or you can install it for general use. Installation for general use must be done from the command line, and you must have permissions to write to the software installation or another designated shared location.

To install a workflow for your own use:

  1. Start Maestro.
  2. Choose Workflows → Knime Workflows → Install. The Install KNIME Workflows panel opens.
  3. Click Browse to locate the directory that you unzipped the workflow to. The Scripts Directory selector opens.
  4. Navigate to the directory that contains the workflow files, and click Choose. The path is entered in the Directory text box in the Install KNIME Workflows panel, and the workflow should be listed in the table below.
  5. Check the box next to the script name, in the Install column, and click OK. The script should now be available as a menu item under Workflows → KNIME Workflows.

To install a workflow for all users of the Schrödinger installation:

Mac/Linux:

  1. Open a terminal window. On Mac, choose Applications → Utilities → Terminal.
  2. Set the SCHRODINGER environment variable to point to the Schrödinger installation:
    
    export SCHRODINGER=installation
    
    On Mac, installation is /opt/schrodinger/suiteyear. If you are using csh or tcsh on Linux, use the setenv command.
  3. Run the script installer to set up and install the workflow.
    
    $SCHRODINGER/run installscripts.py -k -c -d path-to-workflow
    
    where path-to-workflow is the path to the directory where you unzipped the workflow.

Windows:

  1. Open a command prompt window, by choosing Start → All Programs → Schrodinger-year → Schrodinger Command Prompt.
  2. Enter the following command to set up and install the workflow.
    
    run installscripts.py -k -c -d path-to-workflow
    
    where path-to-workflow is the path to the folder where you unzipped the workflow, e.g. "C:\Users\username\Documents".

The workflow is installed into the software installation (in the mmshare-version/python/workflows/ directory).

If you want to use some other common area, you can do so by setting the MAESTRO_WORKFLOW_LOCATION environment variable to the desired directory before starting the installation. If you do this, any colleagues who want to run the workflow must set MAESTRO_WORKFLOW_LOCATION prior to starting Maestro. Instructions for setting environment variables are available in Appendix A of the Installation Guide.

Related Articles:

#1761: How can I provide a KNIME workflow to a colleague for installation into Maestro?

Back to Search Results

Was this information helpful?

What can we do to improve this information?


If you need additional help, please email us at help@schrodinger.com.
Knowledge Base Search

Type the words or phrases on which you would like to search, or click here to view a list of all
Knowledge Base articles