This repository provides User Manual for setting up a Docker environment tailored for testing DGTD code.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Kenneth Jao 8a98ceab8c README to RST format 8 months ago
docs Removed breathe and .venv 8 months ago
.gitignore Added .gitignore and removed unnecessary files 8 months ago
LICENSE second commit 8 months ago
Makefile second commit 8 months ago
README.rst README to RST format 8 months ago

README.rst

Docker 101

This repository documents my understanding of Docker and my attempt to build a Docker image for DGTD (Discontinuous Galerkin Time Domain) code. Docker allows us to package applications and their dependencies into isolated containers, ensuring consistency across different environments.

The documentation is up here.

Building the Docker Image

To build the Docker image for DGTD code, follow these steps:

Command Line Interface (CLI)

Use the following CLI commands to build the Docker image:

docker build -t sample-image .

Replace sample-image with your preferred image name.

Platform Compatibility

The Docker image can be built on both UNIX and Windows platforms. Here’s how I set it up:

  • UNIX: Use Docker Engine.
  • Windows: Install Docker Desktop.

Testing the Docker Image

After building the Docker image, test its functionality on both UNIX and Windows environments:

  • UNIX: Run tests using Docker Engine.
  • Windows: Run tests using Docker Desktop.

The image should maintain consistency and reproducibility across platforms, demonstrating Docker's versatility in managing application dependencies.

Usage

This repository serves as a guide for packaging DGTD code and other applications in Docker containers in the future. Adjust Dockerfile configurations and testing procedures as necessary for specific application requirements.