https://github.com/benst099/bachelorarbeit-egraphs
Development of an application to teach learning content via e-graphs and equality saturation for teaching purposes
https://github.com/benst099/bachelorarbeit-egraphs
e-graph egg egraph egraphs
Last synced: 2 months ago
JSON representation
Development of an application to teach learning content via e-graphs and equality saturation for teaching purposes
- Host: GitHub
- URL: https://github.com/benst099/bachelorarbeit-egraphs
- Owner: BenSt099
- License: mit
- Created: 2024-11-15T14:08:58.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-05-13T19:12:10.000Z (6 months ago)
- Last Synced: 2025-05-13T20:39:21.058Z (6 months ago)
- Topics: e-graph, egg, egraph, egraphs
- Language: TeX
- Homepage:
- Size: 8.32 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bachelorarbeit - EGraphs 
Das Ziel dieser Bachelorarbeit ist es, eine Anwendung für die Lehre zu entwickeln, die
Studentinnen und Studenten Wissen zu den Themen **E-Graphs** und **Equality Saturation** vermittelt. Dabei sollen sie die Möglichkeit haben, sich sowohl auf theoretischer als
auch praktischer Ebene mit den Themen auseinander setzen zu können. Die Grundlage der theoretischen Ebene bildet diese Arbeit, in der notwendige Hintergrundkenntnisse
erarbeitet werden. Außerdem wird ein Einblick in die Implementierung gegeben. Die praktische Ebene besteht aus der Anwendung, mit deren Hilfe Schritt für Schritt aufgezeigt
wird, wie **E-Graphs** und **Equality Saturation** funktionieren. Für größtmöglichen Nutzen soll
die Anwendung zudem plattformunabhängig sein und möglichst nur von _Open-Source-Software_ (OSS) Gebrauch machen. Damit wird das Problem der
unterschiedlichen Betriebssysteme der Studenten umgangen und zeitgleich die Hürden für Erweiterungen gesenkt.
## Overview
## Setup
1. Bitte installieren Sie die [Dependencies](##Dependencies).
2. Laden Sie sich den Code herunter.
3. Führen Sie den Befehl ``fastapi run server.py`` im _src_ Ordner aus.
4. Falls sich der Browser nicht automatisch öffnet, öffnen Sie ihn manuell unter der Adresse http://127.0.0.1:8000.
## Dokumentation
Die Dokumentation kann in der Anwendung unter _Dokumentation_ gefunden werden (bzw. unter der Adresse http://127.0.0.1:8000/dokumentation.html).
## Dependencies
1. [Graphviz](https://graphviz.org/download/)
1. **PATH**: Achten Sie während der Installation darauf, Graphviz zum PATH hinzuzufügen.
2. **Windows**: Achten Sie darauf, dass ``dot`` vom Terminal aus aufrufbar ist; überprüfbar mit ``dot --version``. [Komplette Anleitung für Windows](https://forum.graphviz.org/t/new-simplified-installation-procedure-on-windows/224).
2. Die notwendigen Pakete finden Sie in [requirements.txt](https://github.com/BenSt099/Bachelorarbeit-EGraphs/blob/main/code/requirements.txt):
```shell
pip install -r requirements.txt
```
## Tests
Wenn Sie die Tests ausführen möchten, fügen sie entweder Folgendes zu ``requirements.txt`` hinzu: ``pytest==8.3.3`` und ``httpx==0.27.2`` oder
installieren Sie die Pakete händisch: ```pip install pytest==8.3.3``` ```pip install httpx==0.27.2```.
## License
Dieses Projekt wird unter der **MIT License** veröffentlicht. Für weiterführende Informationen klicken Sie bitte [hier](https://github.com/BenSt099/Bachelorarbeit-EGraphs/blob/main/LICENSE). Das Icon im Logo wurde aus dem Framework [Bootstrap](https://icons.getbootstrap.com/icons/tools/) genommen.