Going further

Imports

When your application becomes complex, you may want to split it into digestible and reusable parts. import is a special keyword you can use to combine multiple YAML files into one application.

A few examples are available here: import.yaml, import2.yaml, import3.yaml. They are self-explanatory.

Nodes

Explore the API reference for a list of available nodes and the test/graphs directory of the corresponding GitHub repositories for examples.

Tools

Useful tools and helpers can be found here: timeflux.helpers.

In particular, you may want to have a look at:

  • timeflux.helpers.viz to generate images from applications, which is very useful to visually debug your application

  • timeflux.helpers.handler if you need to deploy experiments on Windows systems and need to integrate with other software components

If you are developing plugins:

Interfaces

Todo

Work in progress!

The timeflux_ui plugin exposes a powerful JavaScript API to build web apps and interact with Timeflux instances from a browser. Extensive documentation is on its way. Meanwhile, we invite you to explore the available example apps.