https://github.com/jakobhaervig/openfoam-docker-vscode-workflow

This repo accompanies the openfoam-dockerfiles repo and explains how Visual Studio Code can be set up to work efficiently with OpenFOAM installed in Docker.
https://github.com/jakobhaervig/openfoam-docker-vscode-workflow

computational-fluid-dynamics containers docker openfoam visual-studio-code workflow

Last synced: 2 months ago
JSON representation

This repo accompanies the openfoam-dockerfiles repo and explains how Visual Studio Code can be set up to work efficiently with OpenFOAM installed in Docker.

• Host: GitHub
• URL: https://github.com/jakobhaervig/openfoam-docker-vscode-workflow
• Owner: jakobhaervig
• Created: 2021-07-10T21:01:05.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-25T10:54:33.000Z (about 2 years ago)
• Last Synced: 2024-10-11T21:12:24.315Z (3 months ago)
• Topics: computational-fluid-dynamics, containers, docker, openfoam, visual-studio-code, workflow
• Homepage:
• Size: 14.7 MB
• Stars: 31
• Watchers: 2
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Visual Studio Code workflow for OpenFOAM with Docker

Repository describing my favourite workflow combining Visual Studio Code, OpenFOAM and Docker. Make sure to first follow the guide at [https://github.com/jakobhaervig/openfoam-dockerfiles](https://github.com/jakobhaervig/openfoam-dockerfiles) before continuing with this guide.

## 1. Install Visual Studio Code

First, install the text editor [Visual Studio Code](https://code.visualstudio.com).

## 2. Install extensions

In the left panel find "Extensions". Search for and install the following extensions, which will help our OpenFOAM workflow:

1. *Docker*

2. *Dev Containers*

3. *OpenFOAM*

## 3. Associate OpenFOAM-specific files to enable syntax highlighting

![](associateFileExtensions.gif)

## 4. Start Docker container

First, make sure Docker is running and you have a Docker image avialable with your OpenFOAM installation. I have a created a guide [github.com/jakobhaervig/openfoam-dockerfiles](https://github.com/jakobhaervig/openfoam-dockerfiles), which will guide you through the process if in doubt.

Use the alias ``of`` to start a Docker container:

```shell

of

```

If your alias isn't set up correctly, you can start a Docker container by the full command::

```shell

docker container run -ti --rm -v $HOME/openfoam-data:/data -w /data openfoam:latest

```

![](startContainer.gif)

## 5. Attach Visual Studio Code to the running Docker container

Attach Visual Studio Code to the running Docker container. This enables us to access the file system within the container directly in VS Code.

![](attachVSCode.gif)

## 6. Open a folder to access the file system within the Docker container

From within the newly opened window open a folder at root ``/`` to gain full access to the file system of the Docker container.

![](openFolder.gif)

## 7. Open a terminal from within the Docker container

Open a new terminal within the Docker container and test if OpenFOAM is sourced correctly:

```shell

simpleFoam -help

```

![](terminalInContainer.gif)