# 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](overview.md): Python interface for connecting to the FIREQ server.
- [Installation](installation.md): setup of the client and its dependencies.
- [Usage](usage.md): define and launch experiments, collect results, and process outputs.
- [API](api.md): client interfaces for configuration, execution, data, and plotting.

```{toctree}
:maxdepth: 2
:caption: Index

overview
installation
usage
api
```

## Contributing and Support

The GitHub repository for FIREQ-Client is here:

- [FIREQ-Client on GitHub](https://github.com/vlsi-nanocomputing/FIREQ-Client)

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](https://github.com/vlsi-nanocomputing/FIREQ-Client/issues)

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