Skip to content

ICRAR/daliuge-component-examples

Repository files navigation

DALiuGE example components

codecov CI Code style: black

This repository contains dlg_example_cmpts created by ICRAR. These are mostly meant to demonstrate how to implement some of the more advanced DALiuGE features in a component. Please refer to the main DALiuGE documentation for more information.

Installation

There are multiple options for the installation, depending on how you are intending to run the DALiuGE engine, directly in a virtual environment (host) or inside a docker container. You can also install it either from PyPI (latest released version).

Install it from PyPI

Engine in virtual environment

pip install dlg_example_cmpts

Engine in Docker container

docker exec -t daliuge-engine bash -c 'pip install --prefix=$DLG_ROOT/code dlg_example_cmpts'

NOTE: If you had this package installed already you will need to re-start the engine after that.

Usage

For example the MyBranch component will be available to the engine when you specify

dlg_example_cmpts.apps.MyBranch

in the AppClass field of a Python Branch component. The EAGLE palette associated with these components are also generated and can be loaded directly into EAGLE. In that case all the fields are correctly populated for the respective components.