summaryrefslogtreecommitdiff
path: root/datasets/Talluri2021/artifact_documentation.txt
diff options
context:
space:
mode:
Diffstat (limited to 'datasets/Talluri2021/artifact_documentation.txt')
-rw-r--r--datasets/Talluri2021/artifact_documentation.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/datasets/Talluri2021/artifact_documentation.txt b/datasets/Talluri2021/artifact_documentation.txt
new file mode 100644
index 0000000..c95f1ff
--- /dev/null
+++ b/datasets/Talluri2021/artifact_documentation.txt
@@ -0,0 +1,23 @@
+System Requirements:
+Linux (Port forwarding confirmed to work on Linux)
+Docker >= 20.0
+
+The artifact is a docker container that can be pulled from Docker Hub using the command `docker pull sacheendra/or_char`.
+
+The container can then be started using `docker run --rm -p 8888:8888 sacheendra/or_char`.
+
+To reproduce the graphs in the paper:
+1. Start the docker container. (If you are using Docker for Mac or Windows, you might need to expose port 8888 between docker vm and host)
+2. Navigate to localhost:8888 in your browser.
+3. On the webpage, you should see a list of files in a pane on the left.
+4. The code to reproduce the graphs in in Jupyter notebooks. Jupyter notebooks have the extension `.ipynb`.
+5. The noteboks to produce the plots in the paper are numbered from 1 to 5.
+6. To run a notebook, first open it by double clicking it.
+7. The code in the notebook can then be run by opening the `Run` dropdown at top-left, and clicking on the `Run all cells` option.
+
+Figure to notebook reference:
+Figure 1 - Notebook 1
+Table 2 - Notebook 2
+Figure 2 - Notebook 3
+Figure 3 - Notebook 2
+Figure 4 - Experiment in Notebook 4, Plot in Notebook 5 \ No newline at end of file