Welcome to the technical guide for Constellab. This guide will show you how to develop in Constellab. It explains how to create bricks, tasks, protocols, resources, or live tasks.

This guide is for bioinformaticians, data scientists, programmers, or biologists who want to learn more about Constellab and customize their experience.

Dev environment

The dev environment is where you can develop and test tasks, protocols, resources, or views. It's separate from the normal environment, so experiments, resources, and files from the production environment don't exist here.

The development environment includes the Codelab, which is an online IDE based on VsCode. You can develop your bricks or any Python code easily and test it quickly. It also supports Jupyter notebook files, and you can easily install an R environment.

See Dev environment.

Brick

A brick is a python library for Constellab. In contains Tasks, Resources, Protocol and can be installed and manage in a lab. 

This section guides you in creating, deploying, documenting, and managing your brick.

 See Brick.

Task

A Task is a core element in any brick. It's a main part of the workflow found in the playground. A task is a special function that works with Constellab objects. It can execute any code.

Tasks take resources as inputs and produce resources as outputs. They also take a configuration object. For example, the TableTransposer object is a task that takes a Table as input, transposes it, and returns the transposed table as output. Tasks can be connected to each other to be executed, forming a protocol.

This section explains how to create a task inside a brick and explores the possibilities of tasks. It covers developing a simple task, calling command lines, and using virtual environments.

See Task.

Resource

A Resource is a core object used in any brick. It represents data used or generated by tasks, or manually uploaded by a user in the DataBox. Tasks only take resources as inputs and generate resources as outputs. A resource contains different views used to generate visualizations, like charts or tables.

This section explains how to create a custom resource and define its views. It includes a tutorial on creating your own resource.

See Resource.

Live task

Python live tasks are tasks that allow you to execute any Python or R code snippets on the fly. You can write custom code that modifies a table, generates a chart, or calls an external library directly in a task. Live tasks can be easily developed, modified, and shared. In their config, they include parameters and a lightweight version of an IDE to code directly in your lab.

See Live task.

Notice

Gencovery Numerical Resources (GNR) refer to the software, librairies and data provided by us through our web services. GNR may be covered by third-party licenses. Gencovery guarantees that GNR are accessible for your commercial and non-commercial use through Gencovery web services. For ad-hoc use of GNR outside Gencovery web services, please check third-party licenses to ensure you are legally authorised. Gencovery does not warrant or assume any legal liability or responsibility for the accuracy, completeness of any information disclosed through Gencovery web services. This is not a legal notice. Please refer to our terms of use for any legal notice about our web services.