# 🌟 Welcome to Chemunited

```{raw} html
:file: _templates/custom_logo.html
```

## 🚀 Overview

**ChemUnited** provides a user-friendly, visual interface for designing and executing complex lab automation 
workflows. It enables researchers, chemists, and automation engineers to construct, simulate, and monitor experiments through
an intuitive GUI without writing extensive code.

This project is ideal for controlling platform chemistry setups, especially when real-time interaction and visual protocol
design are needed.

---

## 🧠 Features

- 🎛️ **Visual Process Builder**: Drag-and-drop UI to define processes, modules, and steps.
- 🔗 **Connection Graphs**: Manage and visualize physical and logical device connections.
- ⚙️ **Protocol Execution Engine**: Run and monitor experiments in real time.
- 📈 **Timeline Monitoring**: See process evolution and status updates at every stage.
- 🧬 **FlowChem Integration**: Deep integration with [FlowChem](https://github.com/flowchem/flowchem)
to control physical hardware.
- 💡 **Modular Architecture**: Built using PyQt with pluggable component support.

---

## How to start

how?

---

## 🧭 Table of Contents

```{toctree}
:maxdepth: 1
:caption: Start

wellcome/install.md
wellcome/new_project.md

```

```{toctree}
:maxdepth: 1
:caption: Drawing
drawing/drawing.md
drawing/tutorial.md
```

```{toctree}
:maxdepth: 1
:caption: Building Protocols
protocols/build_protocols.md
protocols/module_workflows.md
protocols/script_editor.md
protocols/parameters.md
protocols/pre_running.md
protocols/tutorial.md
```

```{toctree}
:maxdepth: 1
:caption: Simulation
simulation/digital_twins.md
```

```{toctree}
:maxdepth: 1
:caption: Connect devices
connectivity/connectivity.md
connectivity/chemunited_drive.md
```

```{toctree}
:maxdepth: 1
:caption: Monitoring
monitoring/run_monitoring.md
```

```{toctree}
:maxdepth: 1
:caption: Developer

developer/welcome.md
developer/software_design.md
developer/add_components.md
developer/add_features.md
developer/backend.md
```

```{toctree}
:maxdepth: 1
:caption: Reference

reference/components.md
```

---

## 📄 License

This project is licensed under the **MIT License**.

---

## 👨‍🔬 Author & Repository link

**Samuel Saraiva**

Max Planck Institute of Colloids and Interfaces - Automated Chemistry Group

```{raw} html
<a href="https://github.com/automatedchemistry/chemunited" target="_blank" style="text-decoration:none;">
  <img src="_static/github.svg" alt="GitHub" width="28" style="vertical-align:middle; margin-right:6px;">
  <strong>View ChemUnited on GitHub</strong>
</a>
```

📧 samuel.saraiva@mpikg.mpg.de