Skip to content

Commit

Permalink
Merge pull request #12 from gerlero/readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
gerlero committed Aug 10, 2024
2 parents d0d375a + e77b9a3 commit 84c33cc
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
![OpenFOAM](https://img.shields.io/badge/openfoam-.com%20|%20.org-informational)
[![Docker image](https://img.shields.io/badge/docker%20image-microfluidica%2Fopenfoam-0085a0)](https://hub.docker.com/r/microfluidica/openfoam/)

Docker images of both major distributions of OpenFOAM.

Mutliple versions available.`amd64` and `arm64` architectures are supported.

## Usage

### With `docker run`
Expand All @@ -28,6 +32,19 @@ openfoam-docker -image=microfluidica/openfoam:tagname
apptainer run docker://microfluidica/openfoam:tagname
```

### As a base image

Use these images as a base image for your own OpenFOAM-based projects by creating a `Dockerfile` like the following:

```Dockerfile
FROM microfluidica/openfoam:tagname

COPY . /usr/local/myproject

RUN /usr/local/myproject/Allwmake -j -prefix=group \
&& /usr/local/myproject/Allclean
```

## Available tags

### openfoam.com
Expand Down

0 comments on commit 84c33cc

Please sign in to comment.