Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
A
AKIS Cloud Computing
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Max Melchert
AKIS Cloud Computing
Commits
f562b2b3
Commit
f562b2b3
authored
4 months ago
by
Max Melchert
Browse files
Options
Downloads
Patches
Plain Diff
docs: add makefile readme
parent
e128d374
No related branches found
No related tags found
No related merge requests found
Pipeline
#1801
passed
4 months ago
Stage: build
Stage: test
Stage: deploy
Changes
1
Pipelines
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/makefile/README.md
+82
-0
82 additions, 0 deletions
src/makefile/README.md
with
82 additions
and
0 deletions
src/makefile/README.md
0 → 100644
+
82
−
0
View file @
f562b2b3
# Makefile
## Voraussetzungen
> Server-Admin kontaktieren
-
SSH-Public-Key auf Server
-
SSH-Private-Key auf Client
-
SSH-Config auf Client konfiguriert
## Installation
1.
Makefile
[
herunterladen
](
./makefile
)
2.
Makefile in Projektordner speichern
-
Projektstruktur (
[
Beispiel
](
#projektstruktur
)
)
3.
Makefile
[
konfigurieren
](
#konfiguration
)
4.
`make install`
## Bedienung
> siehe [Befehle](#befehle)
1.
`make upload`
Projektdateien hochladen
2.
`make run`
Python-Script ausführen
3.
`make log`
Fortschritt überprüfen
4.
`make download`
Output-Dateien herunterladen
---
## Projektstruktur
> Beispiel
```
txt
/home/max/akis/my_project/
├── data
│ ├── one.pkl
│ ├── three.pkl
│ └── two.pkl
├── main.py
├── makefile
├── output
│ └── empty
└── scripts
├── script-1.py
├── script-2.py
└── script-3.py
```
## Konfiguration
| Variable | Verwendung | Beispiel |
| :-------------------- | :-------------------------------- | :----------------------------------- |
|
`SERVER_USER`
| Server: User Name |
`mmustermann`
|
|
`SERVER_HOST`
| Server: Host Name |
`hyrican-1-extern`
|
|
`CONDA_PATH`
| Server: Conda-Installations-Pfad |
`/home/mmustermann/.local/opt/conda`
|
|
`CONDA_ENV`
| Server: Conda-Environment-Name |
`ml`
|
|
`PYTHON_VERSION`
| Python: Gewünschte Version |
`3.10`
|
|
`PYTHON_PACKAGES`
| Python: Benötigte Pakete |
`tensorflow-cpu matplotlib optuna`
|
|
`MAIN_SCRIPT`
| Auszuführendes Python-Script [^1] |
`main.py`
|
|
`LOG_FILE`
| Log-Datei (optional) [^1] |
`progress.log`
|
|
`LOCAL_PROJECT_DIR`
| Client: Projektordner [^1] |
`.`
|
|
`LOCAL_OUTPUT_DIR`
| Client: Output-Ordner [^1] |
`output`
|
|
`REMOTE_PROJECT_DIR`
| Server: Projektordner [^2] |
`/home/mmustermann/akis/my_project`
|
|
`REMOTE_OUTPUT_FILES`
| Server: Output-Dateien [^1] |
`output/*.svg output/*pkl`
|
[
^1
]:
Relativer
Pfad zum Projektordner
[
^2
]:
Absoluter
Pfad
## Befehle
> `make <target>`
| Target | Aktion | Ort |
| :--------- | :---------------------------------------- | :-------------: |
|
`install`
| Installiert Python Environment und Pakete | Server |
|
`upload`
| Läd veränderte Projektdateien hoch | Client → Server |
|
`run`
| Führt Python Script aus | Server |
|
`kill`
| Bricht Python Script ab | Server |
|
`log`
| Zeigt Log-Datei (optional) an | Client |
|
`download`
| Läd Outputdateien herunter | Server → Client |
|
`delete`
| Löscht Projektdateien | Server |
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment