Add Docker user guide to the README file of the repository #295
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* brief intro * how to build/pull an image * how to run a container on personal computer * how to use containers on HPC systems: singularity
mrp089
requested changes
Oct 31, 2024
* moved the docker section rigth after the introduction * Added an example on how to run a test case inside a container * more detailed on the architecture added * made the job script more readable * moved details on how to build the image from dockerfiles in Docker/README.md
mrp089
approved these changes
Nov 1, 2024
|
Thank you, @dcodoni! This will save SO much time |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Current situation
Currently svFSIplus is compiled in a Docker image, publicly available. Moreover, dockerfiles are also available to build images containing just the environment to compile svFSIplus with both Trilinos and PETSc, and images that includes the precompiled svFSIplus. We do not have any documentation/user guide on how to build Docker images or on how to run a container on a local machine or HPC system.
Release Notes
I added a section in the main README file on Docker which briefly explain how to build images from the provided dockerfiles and how to run simulations using the containers provided or built by the users, on a local machine and on HPC systems.
Documentation
Last section of README file is updated.
Testing
No testing required.
Code of Conduct & Contributing Guidelines