aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2020-05-15 21:01:07 +0100
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2020-05-15 21:01:07 +0100
commit3145984e888b2b38e3eec5c536ca0f2b8a366258 (patch)
tree0f1579dd9c58a50092648204fdfdca73a0e6994a /README.md
parentMerge branch 'bugfix/bee_waggle_6_rounding' (diff)
downloadTCPD-3145984e888b2b38e3eec5c536ca0f2b8a366258.tar.gz
TCPD-3145984e888b2b38e3eec5c536ca0f2b8a366258.zip
Add docker image for tcpd
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index bb9da64..f0b2543 100644
--- a/README.md
+++ b/README.md
@@ -51,8 +51,24 @@ paper](https://arxiv.org/abs/2003.06222):
Many of the time series in the dataset are included in this repository.
However, due to licensing restrictions, some series can not be redistributed
and need to be downloaded locally. We've added a Python script and a Makefile
-to make this process as easy as possible.
+to make this process as easy as possible. There is also a Dockerfile to
+facilitate reproducibility.
+### Using Docker
+
+To build the dataset using Docker, first build the docker containers
+
+```
+$ docker build -t tcpd https://github.com/alan-turing-institute/TCPD.git
+```
+
+then build the dataset:
+
+```
+$ docker run -i -t -v /path/to/where/you/want/the/dataset:/TCPD/export tcpd
+```
+
+### Using the command line
To obtain the dataset, please run the following steps: