FIREQ-Client

FIREQ-Client is the Python-facing interface of the FIREQ platform. It is used to connect to the server, submit experiment configurations, run YAML-defined experiments, collect the resulting data, and perform basic post-processing tasks such as plotting and export.

The client is designed for three main tasks:

• defining and launching experiments,

• communicating with the server during execution,

• saving, organizing, and post-processing experiment outputs.

Quick navigation

For a more detailed explanation, see:

• Overview: Python interface for connecting to the FIREQ server.

• Installation: setup of the client and its dependencies.

• Usage: define and launch experiments, collect results, and process outputs.

• API: client interfaces for configuration, execution, data, and plotting.

Index

• Overview
  • What the client does
  • Typical workflow
  • Main concepts
• Installation
  • Requirements
  • Running the client
• Usage
  • Guideline
• FIREQ Client Architecture & Reference
  • Architectural Overview
  • Interactive & Runtime Lifecycle
  • API Submodules

Contributing and Support

The GitHub repository for FIREQ-Client is here:

• FIREQ-Client on GitHub

Contributions to FIREQ-Client are welcome.

You can contribute by:

• improving the client implementation;

• adding or updating examples in yaml_experiment_configurations_examples/;

• improving the documentation in docs/;

• reporting bugs or unexpected behavior;

• suggesting new features or use cases.

If you find a problem, please open an issue on GitHub:

• Issues

If you have questions, ideas, or need support, feel free to create a discussion or open an issue on GitHub.