Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gerlero/setup-openfoam
Set up your GitHub Actions workflow with a specific version of OpenFOAM
https://github.com/gerlero/setup-openfoam
actions cache caching install openfoam setup
Last synced: about 1 month ago
JSON representation
Set up your GitHub Actions workflow with a specific version of OpenFOAM
- Host: GitHub
- URL: https://github.com/gerlero/setup-openfoam
- Owner: gerlero
- License: gpl-3.0
- Created: 2024-07-23T15:19:17.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-28T13:23:06.000Z (3 months ago)
- Last Synced: 2024-08-29T00:27:44.254Z (3 months ago)
- Topics: actions, cache, caching, install, openfoam, setup
- Homepage:
- Size: 48.8 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# setup-openfoam
[![CI](https://github.com/gerlero/setup-openfoam/actions/workflows/ci.yml/badge.svg)](https://github.com/gerlero/setup-openfoam/actions/workflows/ci.yml)
![OpenFOAM](https://img.shields.io/badge/openfoam-.com%20|%20.org-informational)Installs and activates a specific version of OpenFOAM in the GitHub Actions environment.
## Usage
```yaml
steps:
- uses: actions/checkout@v4
- uses: gerlero/setup-openfoam@v1
with:
openfoam-version: 2406
- run: blockMesh
- run: icoFoam
```## Inputs
### `openfoam-version`
**Required**. OpenFOAM version number (read below for the available versions).
### `cache`
Whether to cache the OpenFOAM installation between runs. Default: `true`.
## Available OpenFOAM versions by runner OS
- **`ubuntu-24.04`**: 2406, 2312 (openfoam.com), 12, 11 (openfoam.org)
- **`ubuntu-22.04`**: 2406, 2312, 2306, 2212, 2206, 2112, 2106, 2012, 2006 (openfoam.com), 12, 11, 10, 9 (openfoam.org)
- **`ubuntu-20.04`**: 2406, 2312, 2306, 2212, 2206, 2112, 2106, 2012, 2006 (openfoam.com), 12, 11, 10, 9, 8, 7 (openfoam.org)
- **`macos-15`**, **`macos-14`**, **`macos-13`**, **`macos-12`**: 2406, 2312, 2306, 2212, 2206, 2112 (via [OpenFOAM.app](https://github.com/gerlero/openfoam-app))
- [Docker `container`](https://docs.github.com/en/actions/writing-workflows/choosing-where-your-workflow-runs/running-jobs-in-a-container) based on:
- `ubuntu:24.04`: 2406, 2312 (openfoam.com), 12, 11 (openfoam.org)
- `ubuntu:22.04`: 2406, 2312, 2306, 2212, 2206, 2112, 2106, 2012, 2006 (openfoam.com), 12, 11, 10, 9 (openfoam.org)
- `ubuntu:20.04`: 2406, 2312, 2306, 2212, 2206, 2112, 2106, 2012, 2006 (openfoam.com), 12, 11, 10, 9, 8, 7 (openfoam.org)
- `debian:bookworm`: 2406, 2312, 2306, 2212, 2206, 2112, 2106, 2006 (openfoam.com)
- `debian:bullseye`: 2406, 2312, 2306, 2212, 2206, 2112, 2106, 2012, 2006 (openfoam.com)
- Windows: not supported