Skip to content
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

Jump to bottom

Improve docker image run documentation #76

Merged
merged 1 commit into from
Jun 28, 2024
Merged

Improve docker image run documentation #76

Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ There are several ways to get the environment ready. Choose any of them:
docker pull bailool/mc-calib-dev # development environment
```

- Run pulled image:
- Run pulled image (set `PATH_TO_REPO_ROOT` and `PATH_TO_DATA` appropriately):

```bash
docker run \
-ti --rm \
--volume="${PWD}:/home/MC-Calib" \
--volume="PATH_TO_DATA:/home/MC-Calib/data" \
--volume="$PATH_TO_REPO_ROOT:/home/MC-Calib" \
--volume="$PATH_TO_DATA:/home/MC-Calib/data" \
bailool/mc-calib-prod
```

Expand Down
6 changes: 3 additions & 3 deletions docs/Windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ docker pull bailool/mc-calib-dev # development environment
```

4. **Running Pulled Image using Docker**
In order to avoid running the image manually every time, we can create a `*.ps1` file containing the necessary docker run commands (or enter the commands manually in Windows Powershell or CMD). Below are the commands necessary.
In order to avoid running the image manually every time, we can create a `*.ps1` file containing the necessary docker run commands (or enter the commands manually in Windows Powershell or CMD). Below are the commands necessary. Set `PATH_TO_REPO_ROOT` and `PATH_TO_DATA` appropriately.


```bash
Docker run `
-ti --rm `
--volume=”$(PWD):/home/MC-Calib” `
--volume=”PATH_TO_DATA:/home/MC-Calib/data” `
--volume=”$PATH_TO_REPO_ROOT:/home/MC-Calib” `
--volume=”$PATH_TO_DATA:/home/MC-Calib/data” `
bailool/mc-calib-prod
```

Expand Down
Loading