Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
M
Multiple Target Tracking
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Terraform modules
Analyze
Contributor analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
phd-courses
Multiple Target Tracking
Commits
0d2bb057
Commit
0d2bb057
authored
3 years ago
by
Anton Kullberg
Browse files
Options
Downloads
Patches
Plain Diff
readme: updated readme with running instructions
parent
cd67529e
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+14
-0
14 additions, 0 deletions
README.md
with
14 additions
and
0 deletions
README.md
+
14
−
0
View file @
0d2bb057
...
@@ -7,6 +7,7 @@ The notebooks are hosted on Binder and can immediately be run.
...
@@ -7,6 +7,7 @@ The notebooks are hosted on Binder and can immediately be run.
# Getting started locally
# Getting started locally
Make sure to have Docker installed on your computer, see
[
Installing Docker
](
https://docs.docker.com/get-docker/
)
. Then follow the steps below.
Make sure to have Docker installed on your computer, see
[
Installing Docker
](
https://docs.docker.com/get-docker/
)
. Then follow the steps below.
### Alternative 1: Building the Docker image locally
#### Step 1
#### Step 1
Clone the repository
Clone the repository
```
```
...
@@ -24,3 +25,16 @@ Run the Docker image
...
@@ -24,3 +25,16 @@ Run the Docker image
docker run --rm -it -p 8888:8888 targettracking
docker run --rm -it -p 8888:8888 targettracking
```
```
This opens up a Jupyter lab instance on port 8888 which you can open in any browser.
This opens up a Jupyter lab instance on port 8888 which you can open in any browser.
### Alternative 2: Pull Docker image from Container Registry
Run the Docker image (with notebooks) by running
```
docker run --rm -it -p 8888:8888 gitlab.liu.se:5000/phd-courses/multiple-target-tracking
```
# Documentation
The documentation is hosted on Gitlab pages but is also buildable locally in the provided Docker image.
To build the documentation the following procedure is suggested.
```
docker run --rm -it -v "$(pwd)":/home/jovyan/work targettracking pdoc --html --output-dir work/html/ src/
```
This will map your current folder into the jovyan/work folder in the container. Then, it builds the documentation to that directory and removes the container. The documentation is available in your current directory.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment