MAP Plugin Database

Overview

The MAP Client is a cross-platform, plugin-based framework for managing scientific workflows. Since plugins are central to the MAP Client's functionality, having a streamlined way to discover and share them is essential for usability.

The MAP Plugin Database is a centralised repository containing metadata about all known, published MAP Client plugins. Its primary purpose is to enable users to search for and install plugins directly from within the MAP Client, eliminating manual installation.

Accessing Plugins

Users can access the MAP Client application's Plugin Finder tool via the Tools menu. This tool allows users to browse and install available plugins from the database.

Submitting a Plugin

MAP Client users are encouraged to contribute their plugins to the database. The recommended submission process is as follows:

1. Navigate to the MAP Plugin Database New Issue page.

2. Create a new issue and add the add-plugin label.

3. In the issue body, include only the GitHub repository path of the plugin in the format:

   {organization}/{repository}
   

   Example: mapclient-plugins/pointsourcestep

Maintaining the Database

Editing database entries and triggering automated updates are restricted to repository maintainers. As a result, when a user submits a new plugin location via a GitHub issue, a repository maintainer must be the one to close the GitHub issue; this ensures the update process has the required permission to update the database.