summaryrefslogtreecommitdiff
path: root/datasets/Talluri2021/README.md
diff options
context:
space:
mode:
authormjkwiatkowski <mati.rewa@gmail.com>2026-05-17 14:21:09 +0200
committermjkwiatkowski <mati.rewa@gmail.com>2026-05-17 14:21:09 +0200
commita5a140c6286e8b113ca8d371f88e3ed54e731cea (patch)
treecd648c36df09d30c217166865a81a0c4e523932b /datasets/Talluri2021/README.md
parenta4102d0252236e85b2813160b4b11e3a19a00d62 (diff)
feat: added lots of citations and slowly finishing the introduction
Diffstat (limited to 'datasets/Talluri2021/README.md')
-rw-r--r--datasets/Talluri2021/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/datasets/Talluri2021/README.md b/datasets/Talluri2021/README.md
new file mode 100644
index 0000000..7f3b862
--- /dev/null
+++ b/datasets/Talluri2021/README.md
@@ -0,0 +1,27 @@
+## Characterization of OutageReport for years 2019 and 2020
+
+This repository contains two datasets extracted from OutageReport webpages in 2019 and 2020. One dataset of total reported failures and another of failure with detailed information.
+
+The datasets are in the Parquet file format.
+
+The Jupyter Notebook files read the datasets, clean them, and generate plots and numbers for characterization.
+
+All the plots used in the paper can be generated by running the jupyter notebooks in order. The plots can also ve viewed in the notebooks themselves.
+
+The easiest way to run the notebooks is to use the prebuilt docker container using the command `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