Do I need this?
You probably only want to use this if you are very new to preCICE and want to learn, for example during our preCICE Workshops or other conferences where we may be present with a training session.
After trying this out for a few days, you probably want to just delete it and install only the components you need directly on your target system.
What is this?
After installing this on any operating system, you will be able to start a virtual machine with Linux and a lightweight graphical interface. You can do anything you like in there, without breaking anything. This will download a very large file (~5GB), will occupy significant storage space (~15GB), and will reserve 2GB of main memory while running, but you can easily delete it when you don’t need it anymore.
This contains all the solvers and adapters used in our tutorials, already built and configured for you to enjoy.
How to use this?
You can use this on any mainstream operating system (Windows/macOS/Linux), but it is necessary that your CPU supports virtualization (most systems nowadays do) and that this is enabled in your BIOS/UEFI settings. Note once more that this will consume a significant amount of storage and main memory space.
- Install Vagrant and VirtualBox (6.0 or later).
- Start your terminal / command prompt and go to an empty directory.
vagrant init precice/precice-vmto prepare the directory.
vagrant upto download the box (~4GB) and start the system.
You can then either use a full desktop (slower but more familiar), or connect to the VM in command-line mode via SSH (faster, can also start GUI).
Starting a full desktop
Open VirtualBox: A new virtual machine should be running. Double-click to open its window. The login password in
After logging in, start a terminal (e.g. terminator) from the applications menu.
You can turn off the system normally from the GUI and start it again with
vagrant up. Your data remains safe until you explicitly delete the VM.
Connecting to the VM via SSH
You can connect to the vm via SSH while being able to also open graphical applications using
vagrant ssh -- -Y. If you don’t need any GUI, then
vagrant ssh is also enough.
If you are using Windows, please install and start Xming (or any other Xserver) first.
Now you are ready to run your first simulation! You can find all the files you need on the Desktop (
Do you have any questions? Help us improve this also by asking on the preCICE forum.
What else may I want to do?
Sharing files and clipboard
Vagrant gives access to the same directory where you downloaded the box into.
If you add any files there from your host system, you will be able to see them in
~/Desktop/shared or in
You can enable copy-pasting text by clicking in the VirtualBox menu bar at
Devices > Shared Clipboard > Bidirectional. The VirtualBox Guest Additions
that enable this are already installed.
Even though you can directly start the VM again by clicking on it in VirtualBox, it is important
that you start it with
vagrant up to set up these features.
Changing the keyboard layout
The default keyboard layout is US English (QWERTY).
Change this clicking on the
Keyboard link on the Desktop,
removing the already added en-us layout, and adding yours.
Adjusting the window scaling
Does everything appear tiny on your high-resolution screen? Adjust the window scaling:
- Click on the start menu (top-left corner)
- Click on “Settings” (left bar, second from bottom)
- Click on “Appearance” (right bar, fourth from top)
- Click on “Settings” (rightmost tab)
- Adjust the “Window Scaling” to 2x (bottommost drop-down)
- Cancel your ophthalmologist appointment. 😎
Installing additional software
You can install additional software using
sudo apt install <package>,
without any password.
In terms of editors, gedit, vim, and nano are already installed.
If you need a more advanced editor with a GUI, you can
install VSCode by running
If you double-click on it, it will run silently. Wait for a bit
and you will then find it under a new category
in the applications menu.
Updating the system
preCICE, the tutorials, and all adapters are installed from their
Git repositories in the home directory, using their main/master branches.
You can do a
git pull at any time to get the latest state
of each package.
You can also update the complete box, but this will delete the previous one and you will lose any changes.
To go back to the state before trying this, run
vagrant box remove precice/precice-vm,
and uninstall Vagrant and VirtualBox.
I found an issue
There are a couple of known issues that we are continuously trying to improve. Your feedback and contribution is always very helpful.