# 📡 Welcome to quansys

**quansys** is a Python toolbox for *fully‑automated* **HFSS** workflows built on top of [PyAEDT](https://github.com/ansys/pyaedt)
supporting **pyepr** simulations based on on the energy-participation-ratio (EPR) method from [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1234567.svg )](https://doi.org/10.5281/zenodo.1234567 ).

* **Structured workflows** – prepare → build → simulate → aggregate  
* **Parameter sweeps** – run grid or custom sweeps with one command  
* **Cluster execution** – optimized for IBM LSF cluster systems
* **JSON / CSV outputs** – results flatten automatically for downstream analysis  
* Ready‑made simulation classes: `EigenmodeAnalysis`, `QuantumEPR`

---

## Where to begin

| Step | Doc |
|------|-----|
| 1. Install the package | [📦 Installation](install.md) |
| 2. Copy example `.aedt` & `.yaml` files | [⚡ Quick‑Start Example Files](getting_started.md) |
| 3. Learn a single simulation run | [🧪 Simulation Guide](guides/simulations.md) |
| 4. Scale up with parameter sweeps | [⚙️ Automation Guide](guides/automation.md) |
| 5. Command‑line helpers | [🖥️ Terminal & CLI](guides/terminal.md) |

---

!!! tip "Jump right in"
    Already have HFSS and Python set up?  
    Head straight to the [Quick‑Start guide](getting_started.md) to clone a working project in seconds.

