From aaeb57d5a2d2d6b5779833334a8c6ee41e17d0a0 Mon Sep 17 00:00:00 2001 From: gpitel Date: Thu, 13 Apr 2023 22:40:59 -0400 Subject: [PATCH] Update BUILD.md Added more setup instructions for preparing and downloading dockerfile Corrected instructions for running tests. --- BUILD.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/BUILD.md b/BUILD.md index 156f889..670d2f8 100644 --- a/BUILD.md +++ b/BUILD.md @@ -1,25 +1,35 @@ +## Setup steps + + Install [Docker for Ubuntu](https://docs.docker.com/engine/install/ubuntu). The installation instructions were tested on the following OS/Docker version combination: +- Docker 23.0.03, Ubuntu 22.04.2 LTS + +Prepare a directory to download and build Docker image. +``` +cd ~ +mkdir openmagnetics +cd openmagnetics +sudo wget https://raw.githubusercontent.com/OpenMagnetics/.github/main/Dockerfile +``` ## Build steps -1. Build Docker image: +Build Docker image ``` +cd ~/openmagnetics docker build -t openmagnetics . ``` -2. Enter built Docker image: +Run built the OpenMagnetics docker image form command line ``` docker run -it openmagnetics bash ``` -3. Run tests: +To confirm proper installation and project compilation run the tests in each project. Each test should run without error. ``` -/home/openmagnetics/OpenMagnetics/MAS -./MAS_tests -/home/openmagnetics/OpenMagnetics/MKF -./MKF_tests -/home/openmagnetics/OpenMagnetics/MVB -python3 tests/test_builder.py +/home/openmagnetics/OpenMagnetics/MAS/build/./MAS_tests +/home/openmagnetics/OpenMagnetics/MKF/build/./MKF_tests +python3 /home/openmagnetics/OpenMagnetics/MVB/tests/test_builder.py ```