🧱 3D STEP Template — CadQuery Development Environment

Dieses Repository enthält ein Template für 3D-Modellierung mit CadQuery in Jupyter Notebooks.
Es dient als Ausgangspunkt für die Erstellung von STEP-Dateien und anderen 3D-Modellen.
Um die Umgebung schnell und reproduzierbar aufzusetzen, verwenden wir UV.

---

🧰 Voraussetzungen

• Windows, Linux oder macOS (Windows mit WSL2 wird unterstützt)
• Internetverbindung
• Git (um das Repository zu klonen)

---

📦 1. UV Installieren

UV ist ein Tool zur Verwaltung von Entwicklungsumgebungen. Es ist schneller als pip und conda.

curl -LsSf https://astral.sh/uv/install.sh | sh

Anschließend die Shell neu laden:

source ~/.bashrc

Teste die Installation:

uv --version

🧱 2. Environment aus lock

In diesem Repository liegt bereits eine exportierte Environment-Datei:

uv.lock

Erstelle die Umgebung mit:

uv sync

Aktiviere die Umgebung auf *Nix:

source .venv/bin/activate

Aktiviere die Umgebung auf Win:

source ".venv\Scripts\activate"

💡 Das Environment enthält alle benötigten Abhängigkeiten inkl. cadquery, jupyterlab und weiterer Python-Pakete.

---

🧪 3. Jupyter Notebook starten

Starte im aktivierten Environment die Jupyter Lab Umgebung:

jupyter lab

oder klassisch:

jupyter notebook

Öffne anschließend im Browser das Notebook:

part_template.ipynb

👉 Alternativ kannst du das Notebook auch direkt starten:

jupyter lab part_template.ipynb

---

📝 Hinweise

• Wenn du Pakete nachinstallierst, kannst du das Environment jederzeit aktualisieren:

  uv add <paketname>

• So stellst du sicher, dass andere Nutzer exakt dieselbe Umgebung nutzen.

---

📤 STEP-Dateien exportieren

Lokaler Export

Um die im Notebook definierten 3D-Modelle als STEP-Dateien zu exportieren, führe das bereitgestellte Skript aus:

python .github/scripts/export_step.py --notebook part_template.ipynb --outdir out

Dies führt das Notebook aus und speichert die STEP-Dateien (z. B. final_block.step und insert_plate.step) im Ordner out.

GitHub Action für Releases

Das Repository enthält eine GitHub Action, die automatisch STEP-Dateien exportiert und als Release-Assets hochlädt, wenn du einen Tag pusht.

1. Erstelle einen Tag (z. B. v1.0.0):

   git tag v1.0.0
   git push origin v1.0.0

2. Die Action läuft automatisch und erstellt ein Release mit den STEP-Dateien als Anhänge.

Du kannst die Action auch manuell über "Actions" in GitHub auslösen.

---

🧹 Deinstallation / Aufräumen

Um die Umgebung wieder zu löschen:

rm -r .venv

Um UV selbst zu entfernen, lösche den Installationsordner.

uv cache clean # Cache leeren
rm -rf "$(uv python dir)" # Python-Versionen entfernen
rm -rf "$(uv tool dir)" # UV-Tools entfernen

rm ~/.local/bin/uv # Linux/macOS
Remove-Item $HOME\.local\bin\uv.exe # Windows

---