From c024c70f80d1994e86db998fad38c60fa00f4e50 Mon Sep 17 00:00:00 2001
From: Julien <peloton@lal.in2p3.fr>
Date: Fri, 8 Feb 2019 13:31:14 +0100
Subject: [PATCH] Update the README with instructions

---
 README.md | 30 ++++++++++++++++++++++++++++--
 1 file changed, 28 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d3a4d58..4a15ff9 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,28 @@
-# 1807.03078
-Supplementary material for arXiv:1807.03078
+# Analysing billion-objects catalogue interactively: Apach Spark for physicists
+
+This repository contains supplementary material for arXiv:[1807.03078](https://arxiv.org/abs/1807.03078).
+
+## How to run the notebook
+
+You must have [Apache Spark](http://spark.apache.org/) and [Jupyter notebook](https://jupyter.org/) installed on your machine or your cluster. 
+
+### On a local machine
+
+```bash
+PACK="com.github.astrolabsoftware:spark-fits_2.11:0.7.2"
+PYSPARK_DRIVER_PYTHON_OPTS="jupyter-notebook" pyspark \
+     --master local[*] \
+     --packages $PACK 
+```
+
+### On a cluster
+
+Standalone mode:
+
+```bash
+PACK="com.github.astrolabsoftware:spark-fits_2.11:0.7.2"
+PYSPARK_DRIVER_PYTHON_OPTS="jupyter-notebook --debug --no-browser --port=$PORT1" pyspark \
+     --master $SPARKURL \
+     --packages $PACK \
+     --driver-memory $MEMDRIVER --executor-memory $MEMEXEC --executor-cores $EXECCORES --total-executor-cores $TOTALCORES
+```
\ No newline at end of file