Skip to content

Latest commit

 

History

History
114 lines (65 loc) · 6.32 KB

howto_kitematic_win.md

File metadata and controls

114 lines (65 loc) · 6.32 KB

Galaxy RNA workbench on Kitematic for Windows

This how-to will guide you through the steps that are needed to run the Galaxy RNA workbench on Windows by setting up Kitematic, a tool which provides a graphical user interface to run Docker containers stored on Docker Hub.

Installation prerequisites

Before proceeding, make sure your system is up to date using Microsoft's Windows Update.
Finally, go to Kitematic's page, and download the Docker Toolbox.

▲ back to top

Installation procedure

The following instructions are based on our Kitematic installation screencast:

  1. Once downloaded, place the Docker Toolbox installer where it is more convenient for you (here we placed it on the desktop for simplicity). Once the Docker Toolbox package is fully downloaded, double-click to proceed to its installation.

install_01.png

  1. The Docker Toolbox installer starts. Click Next to proceed with the installation.

install_02.png

  1. Set the location where you want to install the Docker Toolbox. Click Next.

install_03.png

  1. The installer gives an overview of what is provided in the Docker Toolbox. As you can see, Kitematic is going to be installed alongside Docker, providing a desktop GUI for managing its images and containers. Click Next.

install_04.png

  1. Leave the post-installation tasks to their default to obtain all Docker Toolbox's desktop icons. Click Next.

install_05.png

  1. Review the provided installation location and components. Click Install.

install_06.png

  1. The installation completes by creating all Docker Toolbox's icons in the defined location. By leaving the settings at their defaults, these will appear on the desktop. Click Finish.

install_07.png

The installation is now complete.

▲ back to top

Launching the workbench

  1. Locate the Kitematic icon within your system's directories (this will be on the desktop if you left the installation settings as default), and launch it. The Docker GUI starts. Let it load.

launch_01.png

  1. Once loaded, the GUI asks you to connect to Docker Hub to retrieve publicly available Docker images.
    Insert your credentials, and click Login.

launch_02.png

  1. Once logged in, the GUI shows some popular Docker images readily available for running on your system.
    We are interested in the Galaxy RNA workbench. Type galaxy-rna-workbench in the search bar located on the top of the window to search for this image on the Docker Hub.

launch_03.png

  1. The search dialog shows the retrieved results. Select the first on the left by clicking Create.

launch_04.png

  1. A connection to the Docker Hub is started for the retrieval of the RNA workbench.

launch_05.png

Running out of space? Check out our troubleshooting section.

  1. Once fully downloaded, the Docker container starts, loggin messages on the console. A web preview of the Galaxy RNA workbench is provided next to the console log. Click on the preview window to open it in a browser.

launch_06.png

  1. The workbench is opened in your default browser, where you can readily start working on your workflows.

launch_07.png

The opening page shows some useful options to configure Galaxy, install new tools, or try the workbench through guided tours. Tours are interactive demos that show how the interface works in different usage scenarios.

▲ back to top

Taking a tour

Try the workbench through a guided tour. Tours are interactive, and can be stopped at any time, providing you an overview of what can be done through Galaxy, using its tools, and reusing all available workflows.

To have an introductory tour on how to get accustomed with the Galaxy interface, click on Help -> Interactive Tours, and select the Galaxy UI tour.

tour_01.png

Your Galaxy RNA workbench tour has started. Have fun! :)

▲ back to top

Troubleshooting

Running out of space

Kitematic creates virtual machines with a default storage space of 20GB. The RNA workbench is roughly 12GB, therefore if you want to increase disk space, use the Docker CLI (Docker Command Line Interface) that was installed alongside Kitematic.

Once opened, expand the storage space of your virtualbox default machine with the following command:

docker-machine -D create -d virtualbox --virtualbox-disk-size "100000" default

This error is likely to happen when you try to download the workbench a second time on the same virtual machine, after having stopped and removed the container that was created the first time your run it. In this case you can avoid resizing the storage space: just create a new container by clicking + New, and go to the My Images tab. You will see a list of all the images you already downloaded from Docker Hub. Locate the one of the RNA workbench, and click create.

▲ back to top