Claudio Gomes 191c07baa7 moved too many files 6 سال پیش
..
notebooks ff1ef37a40 modelica exercises 6 سال پیش
notes 191c07baa7 moved too many files 6 سال پیش
DockerfileTutorials123567 d25ec30343 reorganize files 6 سال پیش
DockerfileTutorials4 d25ec30343 reorganize files 6 سال پیش
README.md c10f2c9381 solution end tag should not be the last of the cell. 6 سال پیش
generate_exercises.ps1 ff1ef37a40 modelica exercises 6 سال پیش
generate_exercises.py c10f2c9381 solution end tag should not be the last of the cell. 6 سال پیش
test_bondgraphs.py 191c07baa7 moved too many files 6 سال پیش

README.md

Objective

This repository contains the materials that are used in the MoDELS tutorial of physical systems modelling for software engineers, in 2019.

Running the Materials

  1. Install Docker.

  2. Using docker's console, navigate to materials folder in this repository.

  3. Build the corresponding docker image (each requires about 5GB of disk space):

    docker build -f DockerfileTutorials123567 -t jupyter .
    

    or

    docker build -f DockerfileTutorials4 -t jupyter .
    

This will download all dependencies you need to run the examples. You might need root access. It is advised to both docker images before starting the exercises. This will ensure that any problem will be detected and solved early.

  1. Note the host's ip address by running:

    docker-machine ip
    

    Let us denote it by MACHINE_IP

  2. Run the docker container:

    docker run --name jupyterrun -p 8888:8888 -t jupyter
    

    This will start a container with name jupyterrun of the image tagged with jupyter and will forward any traffic going into port 8888 (in the host machine) to the same port in the virtual machine. If a token is given, copy it so that you can later access the jupyter notebook from your browser. Let TOKEN denote the token given.

  3. Open your browser and navigate to http://MACHINE_IP:8888/. If asked for a token, insert TOKEN.

  4. Explore the examples.

  5. Any changes made in the notebooks affect only the files inside the container. To retrieve them, either use the notebook interface to download them to your computer (File -> Download As -> Notebook), or detach from the jupyterrun container (typing Ctrl+C on docker's console), and use the following command on docker's console:

    docker cp jupyterrun:/opt/notebooks/ mynotebooks
    

    Which will copy all files under the tutorial folder to the mytutorial folder in the repository.

  6. To terminate and clean up, run the following commands

    docker stop jupyterrun && docker rm jupyterrun
    

Common Problems

No space left on device error

This is usually caused by having pre-existing docker images in your pc. Since docker allocates a virtual hard disk for them, this disk may be full.

One solution is to run, in the docker terminal:

docker image prune

Which should reclaim some space.