Skip to content

Install the Example Plugin

When To Use This

A Firecube plugin is a separately installed Python package that tells Firecube how to discover, read, and convert a particular dataset. Firecube runs the ingestion workflow and manages the output product.

This page installs the published firecube-quickstart-plugin example. It already implements dataset conversion for a small set of time-indexed NetCDF files, so this quickstart does not require you to write any plugin code.

Prerequisites

  • Firecube installed in a Python environment.
  • The environment activated with source .venv/bin/activate.
  • Run commands from the firecube-quickstart/ directory created during installation.
  • git installed.

Steps

Clone The Plugin

git clone https://github.com/eumetsat/firecube-quickstart-plugin.git

Keep running commands from firecube-quickstart/, one level above the cloned plugin, with the same environment active throughout.

Install The Plugin

Install the cloned project into the quickstart environment. Use --editable for development (source changes take effect immediately without reinstalling). Copy mode (the default) is safer for production deployments.

firecube plugins install --editable firecube-quickstart-plugin

Expected output ends with:

Detected plugins: quickstart_plugin

Validate The Installation

firecube plugins describe quickstart_plugin

Next Steps