A webbased tool for learning slurm based on Corelearning.
Before we get started you should have the following programs installed:
- Python3 (>=3.5 with pip)
- Nodejs
- Typescript
- docker
This project uses the Docker API for communicating with the docker container over a websocket. So you will need to set your docker up to use a tcp listener. More information can be found here.
We recommend that the socket only listens to requests coming from localhost.
If that is what you wish add -H tcp://127.0.0.1:2375 to the startup of your
docker server. If you want to use a different port or address then please do
so, but remember to change docker-url in config.yaml.
To build the docker image run docker build . -t slurm-debian. This will
create a docker image with the same tag as specified in
config.yaml.
Inside corelearning/server you should run the command
pip3 install -r requirements.txt and in corelearning/html you should run
npm install. After running npm install in corelearning/html you should run
webpack to compile the typescript.
From the root directory of this repository run the command
python3 corelearning/server/main.py.
The html can be hosted with any webserver.
The config file, config.yaml, contains all information needed for the system to run. Some information is defined by the docker image and some is needed for corelearning.
websocket-host is the ip of the server running the python backend. While
developing, it should not be nessecary to change it away from 127.0.0.1. When
deploying it should be set to the external IP address of your server.
docker-image is the tag of the docker image. So if you used a different tag
than described earlier in this guide, then you should set it here.
docker-url has been described earlier.
Please read CONTRIBUTING.md for details on the process for submitting pull requests, bugs, and feature requests to us.
This project is licensed under the EUPL License - see the LICENSE file for details.