Skip to content

Update BUILD.md #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gpitel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update BUILD.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions BUILD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```