diff --git a/README.md b/README.md index 7a6a85562c399598a276afb9ada6543bfb0ef0ef..e9edd20445f1019ec7d142b14c296897a49781c3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,26 @@ Code repository for Python implementations of some multiple target tracking algorithms. See Getting started for information on how to run the code and generate result plots. -# Getting started -TBD \ No newline at end of file +### Run Notebooks on Binder +The notebooks are hosted on Binder and can immediately be run. +[](https://mybinder.org/v2/git/https%3A%2F%2Fgitlab.liu.se%2Fphd-courses%2Fmultiple-target-tracking/HEAD) + +# 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. + +#### Step 1 +Clone the repository +``` +git clone https://gitlab.liu.se/phd-courses/multiple-target-tracking.git +cd multiple-target-tracking +``` +#### Step 2 +Build the Docker image +``` +docker build -t targettracking -f Dockerfile . +``` +#### Step 3 +Run the Docker image +``` +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.