Getting Started

Installation

The plugin is currently available on two platforms. To install it from one of these, two steps are required:

Intall from GitHub

1. Clone the git repository
   At first the plugin hast to be cloned from the Git Repository into a directory of your choice:
   git clone https://github.com/DLR-RM/rafcon-task-planner-plugin.git
   

2. Register the Plugin in RAFCON
   To register the plugin in RAFCON, it’s plugin path has to be added to RAFCON’s plugin path variable. The plugin path is [repository_path]/source/rafcontpp, so adding it would look like:
   export RAFCON_PLUGIN_PATH=$RAFCON_PLUGIN_PATH:[repository_path]/source/rafcontpp
   More information about, how to add plugins to RAFCON can be found in the RAFCON Documentation.
   

Install form PyPI

1. Obtain the Plugin
   The Plugin can be downloaded using pip:
   pip install rafcon-task-planner-plugin
   

2. Register the Plugin in RAFCON
   To register the plugin in RAFCON, it’s plugin path has to be added to RAFCON’s plugin path variable. The plugin path is [SITE-PACKAGES-PATH]/rafcontpp, so adding it would look like:
   export RAFCON_PLUGIN_PATH=$RAFCON_PLUGIN_PATH:[SITE-PACKAGES-PATH]/rafcontpp
   More information about, how to add plugins to RAFCON can be found in the RAFCON Documentation.
   

If the steps were executed correctly, RAFCON should load the plugin on it’s next start. The best indicator that everything worked well is, that the GUI should have a new Button “Plan Task” in the Menu Bar.
After downloading a planner, next steps could be to play around with the plugin, read more documentation, or start with the tutorials.

Dowloading a Planner

The plugin dosen’t work without a semantic planner. How to download one, and prepare it for RTPP is described in the Built-in Planner Section. It’s recomended, to start with The Fast Downward Planning System.