Skip to content

Commit 3ce5b29

Browse files
authored
Training: Add instructions for new VM image (#638)
1 parent 0a4d9b7 commit 3ce5b29

File tree

1 file changed

+59
-4
lines changed

1 file changed

+59
-4
lines changed

content/community/community-training.md

Lines changed: 59 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,17 +56,72 @@ We parallelize the same Python codes used in the Basics module, we analyze the p
5656

5757
## How to prepare?
5858

59-
In our training courses, we typically bring along some Ubuntu Live USB sticks with all the dependencies pre-installed. They should work on any laptop with an x86 CPU, as long as you have the rights to boot from USB. In particular, these do not work on Apple silicon systems.
59+
On the technical side, the training course involves multiple components of the preCICE ecosystem, as well as third-party solvers and pre- and post-processing tools.
60+
Most of these tools work best (or only) on a Linux system.
61+
You can either (a) use a prepared system image that we provide (e.g., in a virtual machine), or (b) install the dependencies directly on your system.
62+
To reduce system-related friction during the training, we recommend starting with option (a).
6063

61-
In case you would like something more permanent, but still with low setup effort, you can download the [preCICE Demo Virtual Machine](installation-vm.html). Note that downloading this will take a while, so better prepare this early enough.
64+
{% important %}
65+
At the end, verify your installation, and contact us as soon as possible regarding any issues.
66+
Find verification instructions at the end of each section.
67+
{% endimportant %}
6268

63-
Finally, in case you prefer to install everything in your laptop, you will need the following:
69+
### Provided system
70+
71+
We have prepared a modified Ubuntu image that includes all the tools we will use (different from the demo VM).
72+
With the training instructions, you will receive a URL with an up-to-date image for the specific training.
73+
With this `.iso` file, you can either:
74+
75+
- prepare a virtual machin (VM), e.g., using [VirtualBox](https://www.virtualbox.org/)
76+
- create a bootable USB stick, e.g., using [Etcher](https://etcher.balena.io/), and use your system directly
77+
78+
In both cases, you can either install the modified Ubuntu image, or try a live session, without any permanent changes (or result file saves) to your system.
79+
Get the smoothest experience by installing the image in a VM, so that your changes are saved between sessions, and you can at the same time access your host OS.
80+
81+
{% note %}
82+
At the moment, this image is only available for Intel/AMD x86-64 CPUs.
83+
In our on-site trainings, some prepared USB sticks are provided.
84+
These should work on any laptop with an x86-64 CPU, as long as you have the rights to boot from USB. In particular, these do not work on Apple Silicon systems.
85+
{% endnote %}
86+
87+
Configure the VM with these settings:
88+
89+
- At least 8GB of RAM (the system will not load with 4GB in the "try" mode).
90+
- Ideally, four logical CPU cores (one is also fine).
91+
- At least 64MB of video RAM (more -> smoother graphics).
92+
- At least 25GB of storage.
93+
94+
For VirtualBox, find these settings under the `System`, `Display`, and `Storage` categories.
95+
96+
Further important settings:
97+
98+
- The OpenFOAM adapter is installed under `~/OpenFOAM/ubuntu-v2406`. If you install (not "try" in a live session), move that directory to your user: `cd ~/OpenFOAM/ && mv ubuntu-v2406/ $USER-v2406`.
99+
- Set your keyboard layout: In the Ubuntu applications menu, type "keyboard layout". Select "Add input source". Remove the default one.
100+
101+
**Optional:** If you choose to install the image in a VM, you probably want to better integrate it with your host system. For VirtualBox, you need to [install the Guest Additions](https://www.virtualbox.org/manual/ch04.html) and set up a [shared folder](https://www.virtualbox.org/manual/ch04.html#sharedfolders):
102+
103+
1. Devices > Insert Guest Additions CD Image
104+
2. Navigate to the CD
105+
3. Execute `autorun.sh` and give your password
106+
4. It automatically installs the Guest Additions. Press Enter to exit at the end.
107+
5. Set up a shared folder: Devices > Shared Folders > Shared Folders settings... > Add
108+
6. Folder Path: folder in your host system
109+
7. Mount point: Where to find the folder in the VM system. For example, `/mnt/training`.
110+
8. Select "Auto-mount" and "Make Permanent"
111+
9. Inside the VM, execute `sudo adduser $USER vboxsf`
112+
10. Restart the VM
113+
114+
To check your installation, run the [1D elastic tube tutorial](tutorials-elastic-tube-1d.html) (Python solvers) inside the VM.
115+
116+
### Individual dependencies
117+
118+
In case you prefer to install everything on your system, you will need the following:
64119

65120
- [preCICE](installation-overview.html)
66121
- [preCICE Python bindings](installation-bindings-python.html):
67122
- Create a virtual environment: `python3 -m venv .venv && source .venv/bin/activate`. As long as the environment is active, you will see `(venv)` before your command prompt. You need to activate the venv in new terminal windows.
68123
- Install the bindings: `pip3 install pyprecice` (check with running `import precice` in a Python interpreter)
69-
- matplotlib: In the same virtual environment, run `pip3 install matplotlib`
124+
- matplotlib and numpy v1.x: In the same virtual environment, run `pip3 install matplotlib numpy==1.26.4`
70125
- [ParaView](https://www.paraview.org/) (visualization, used in most modules apart from the basics)
71126

72127
The tools module also needs (all optional):

0 commit comments

Comments
 (0)