staudtyves/infrastruktur-dok
1
0
Fork 0
forked from CDS/infrastruktur-dok
Code Pull Requests Activity

.

Browse Source
This commit is contained in:
Thomas Keller 2025-05-14 17:06:51 +02:00
parent 87f52975dc
commit e3164e36e8
1 changed files with 0 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
Anleitung-Remote-Development-mit-Pycharm.md
View File

@ -1,50 +0,0 @@
## Remote Development mit Pycharm Professional auf den CDS Workstations - Anleitung Installation
### Aufsetzen einer serverseitigen Entwicklungsumgebung
![Pycharm Gateway](./images/preview_gateway.png)
#### Einleitung
Um die Entwicklung eines Programmierprojektes oder eines einfachen Skriptes weiter zu vereinfachen, gibt es Integrierte Entwicklungsumgebungen (IDE) die mithilfe von SSH auf externe Rechner zugreifen können. Sowohl [Visual Studio Code](https://code.visualstudio.com) von Microsoft als auch [PyCharm](https://www.jetbrains.com/de-de/pycharm/) von JetBrains bieten hierzu eigene Lösungen an. Die Auswahl eines solchen Tools ist eine vorwiegend subjektive Entscheidung. In dieser Anleitung wird das Aufsetzen des Remote Development Tools von PyCharm vorgestellt.
## 1. Schritt: Pycharm Professional beantragen
Alle Studierenden der FHGR können für ihr Studium eine [PyCharm Professional Lizenz](https://www.jetbrains.com/lp/leaflets-gdc/students/) beantragen. Nach dem Ausfüllen des Antrages mit der Angabe der Studierendenmail wird ein JetBrains-Account erstellt, mit welchen man sich nun nach dem Herunterladen von [PyCharm Professional](https://www.jetbrains.com/pycharm/download/?section=windows) einloggen kann. Damit sollte die volle Funktionalität von PyCharm freigeschaltet werden. Im Rahmen des Unterrichts können wir alle die 30-tägige Probelizenz aktivieren, falls die Lizenzen noch nicht bereitgestellt wurden.
## 2. Schritt: Hinzufügen einer Workstation zur IDE und Installation der Remote-Entwicklungsumgebung
###**Achtung: Für alle folgenden Schritte muss man entweder mit dem internen FHGR WLAN oder mit dem VPN Client verbunden sein.**
Nach der erfolgreichen Installation von PyCharm Professional sollte der Menüpunkt unter "File/Remote Development" (Deutsch: "Datei/Remote-Entwicklung") verfügbar sein. Bei der Auswahl des Menüpunktes wird das folgende Fenster angezeigt:
![Remote Development](./images/remotedevelopment_menu.PNG)
In diesem Menu können wir beim Punkt SSH Connection die Option "New Connection" auswählen und eine Workstation wie zum Beispiel Palladium **palladium.fhgr.ch** mit dem eigenen Benutzernamen hinzufügen:
![Add Host](./images/remotedevelopment_addhost.PNG)
In einem nächsten Schritt muss das eigene Passwort für die vollständige Authentifizierung eingegeben werden. Dieses kann auch durch PyCharm permanent gespeichert werden:
![Add Host with password](./images/remotedevelopment_addhost_pw.PNG)
Im nächsten Fenster können wir ein IDE auswählen, welche wir auf der Workstation gerne installieren möchten. Wir wählen hier eine Version von PyCharm Professional aus. Gleichzeitig können wir den Verzeichnispfad für das Projekt auswählen. Falls wir ein neues Verzeichnis bzw. Ordner für das Projekt erstellen möchten, so wählen wir die Option **open a SSH terminal** und geben den bekannten Befehl ```mkdir projektname``` ein. Danach sollte das Verzeichnis, hier im Beispiel "home/user/projektname", auswählbar sein. Alternativ kann in diesem Schritt auch ein Github-Repositorium mit dem Befehl ```git clone <repolink>``` geklont werden und anschliessend als Projektverzeichnis festgelegt werden:
![IDE and Project](./images/remotedevelopment_project.PNG)
Nun wird die IDE einmalig auf die Workstation installiert. Gleichzeitig wird das Unterprogramm "JetBrains Gateway" installiert und gestartet.Für diesen Vorgang muss nochmals das **Passwort** eingegeben werden.
## 3. Schritt: Geöffnetes Projekt in der Remote IDE
Nachdem wir die Remote IDE erfolgreich im gewünschten Verzeichnis gestartet haben, werden wir von folgendem Fenster begrüsst und können mit dem Programmieren beginnen:
![Project on server](./images/remotedevelopment_project_overview.PNG)
Dabei stehen uns die meisten Funktionalitäten von PyCharm wie bspw. Python-Paketmanager oder Debugger zur Verfügung. Parallel wie in der lokalen PyCharm Installation kann eine virtuelle Python-Umgebung (venv) oder eine Conda Umgebung als Python-Interpreter aufgesetzt werden.
Im Data Science Bereich kommt es häufig vor, dass trotz der verfügbaren grösseren Rechenressourcen auf der Workstation, ein Programm bzw. Python Skript so lange rechnen muss, dass keine dauernde Verbindung zum Rechner möglich ist. Hierzu bietet die Remote IDE die Möglichkeit trotz Schliessen der IDE, das Programm weiterhin auf dem Server laufen zu lassen:
![remotedevelopment_keeprunning](./images/remotedevelopment_keeprunning.PNG)