# ⚛️ FerraX IDE

[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Version](https://img.shields.io/badge/version-1.0.0--beta-orange)](https://github.com/FerraXIDE/FerraX-IDE)
[![Made with Qiskit](https://img.shields.io/badge/Made%20with-Qiskit-6133B4)](https://qiskit.org)

**A visual IDE for quantum programming, powered by the Text4q language.**

FerraX IDE is a web-based Integrated Development Environment designed to make quantum programming accessible to everyone. Create, visualize, and simulate quantum circuits using simple, natural-language–like syntax — no prior quantum experience required.

---

## ✨ Key Features

| Feature | Description |
|---------|-------------|
| 🎨 **Visual & Interactive IDE** | Full web interface with editor, circuit panel, and integrated tools |
| 📝 **Text4q Language** | Write quantum commands with simple syntax: `Create 2`, `H 0`, `CX 0 1` |
| 🌍 **Multilingual** | Supports Spanish, English, French, Zapotec, Maya, and Nahuatl |
| 🔄 **Code Generation** | Translates commands into Python/Qiskit code with one-click copy |
| 👁️ **Real-Time Visualization** | Circuit updates instantly as you type |
| ⚪ **Bloch Sphere** | Visualize single qubit states in interactive 3D |
| 📊 **Simulation Results** | Run basic simulations and view probability histograms |

---

## 🚀 Getting Started

FerraX IDE is a web application — **no installation required**. Just a modern browser.

### 1. Open FerraX IDE
Launch the application from your local server or hosted environment.

### 2. Write your first program
In the left editor panel, type:

```text4q
Create 2
H 0
CX 0 1
Measure 0
Measure 1
```

### 3. Watch the circuit appear
The quantum circuit is automatically drawn in the central panel.

### 4. Copy the generated code
Use the bottom panel to copy ready-to-run Python/Qiskit code.

---

## 💡 Example: Bell State (Entanglement)

**Text4q code:**
```text4q
Create 2
H 0
CX 0 1
```

**Generated circuit:**
- Two qubits (`q0`, `q1`)
- Hadamard gate on `q0`
- CNOT gate (control: `q0`, target: `q1`)

**Generated Qiskit code:**
```python
from qiskit import QuantumCircuit
qc = QuantumCircuit(2, 2)
qc.h(0)
qc.cx(0, 1)
# qc.measure_all()  # When "Measure" commands are added
```

---

## 📁 Project Structure

```
FerraX-IDE/
├── index.html         # Main web application
├── app.html           # Compiler web application
├── LICENSE            # Apache 2.0 License
├── NOTICE             # Third-party attributions (Qiskit)
└── README.md          # This file
```

---

## 🛠️ Technologies Used

| Technology | Purpose |
|------------|---------|
| **Qiskit** | Quantum simulation engine and code generation |
| **JavaScript / HTML5 / CSS3** | UI and SVG circuit rendering |
| **Canvas API** | 3D Bloch Sphere visualization |
| **Font Awesome** | Interface icons |

---

## 📄 License & Attribution

- **Source code:** FerraX IDE and Text4q compiler are licensed under **Apache License 2.0**.
  See the [LICENSE](LICENSE) file for full terms.

- **Third-party software:** This product includes:
  - **Qiskit** ([https://qiskit.org](https://qiskit.org)) — Copyright 2017–2024 IBM Corporation  
    Used under the Apache License 2.0.

Full attribution details in the [NOTICE](NOTICE) file.

---

## ⚠️ Educational Purpose Disclaimer

> FerraX IDE is an **educational tool** designed for learning and experimentation.

- Simulations and visualizations may have limitations.
- Not intended for scientific research, commercial development, or critical purposes without independent verification.
- This software is distributed "AS IS" — see Section 7 of the Apache License 2.0.

---

## 🤝 Contributions & Contact

Found a bug? Have an idea for a new feature? Want to help translate Text4q into more languages?

| Activity | How to contribute |
|----------|-------------------|
| 🐛 Report bugs | Open an [Issue](https://github.com/FerraXIDE) |
| 💡 Suggest features | Open an [Issue](https://github.com/FerraXIDE) |
| 💻 Contribute code | Fork the repo and create a Pull Request |
| 🌐 Translations | Contact directly (see below) |

**Author:** Gabriel De Jesús Sánchez Ferra  
**GitHub:** [https://github.com/FerraXIDE](https://github.com/FerraXIDE)

---

## 🙏 Acknowledgments

- To my dear family, who has always supported me in everything I do ❤️
- To IBM Qiskit for their incredible open-source framework
- To the Zapotec, Maya, Nahuatl, and all language communities for inspiring the inclusion of indigenous languages
- To all educators and students who help grow quantum computing

---

## 📊 Project Status

| Item | Details |
|------|---------|
| **Current version** | 1.0.0-beta |
| **License** | Apache 2.0 |
| **Last updated** | 2026 |

---

*Made with ❤️ and qubits*