From ad2d6a39c08fb4872a3e11e7682d5824f5e62f76 Mon Sep 17 00:00:00 2001
From: Quentin Codelupi <quentin.codelupi@cern.ch>
Date: Tue, 30 Jul 2019 15:48:32 +0200
Subject: [PATCH] [update] readme for routine
---
README.md | 20 ++++++++++++++++----
1 file changed, 16 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index c36b31b..860348f 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,24 @@
-# BiBl NXCALS Property Pull
+# BLM NXCALS Property Pull
Property pull is a Python project for the Cern's BLM section.
It get precise data property for diamond devices by NXCALS and store it in lighter format on a MYSQL DB.
In order to be used in other application.
+A routine script have been done in order to get the beamMode data
+from pytimber and pull the data accordingly.
+
+The final purpose is that it run daily on a server with a cronJob.
+
+An API may be develop in the future for precise data pull without DB writing.
+Meaning an instant return (JSON format) of data required.
+
## Installation
For now, it only work on linux OS and Windows Professional,
and not tested on MacOS.
+
+At the time of writing, `python3.6` is required to run the CERN's
+Spark bundle propertly.
In order to run it, you have to Download the CERN's Spark bundle
and set up a working CERN's NXCALS environment.
@@ -15,12 +26,13 @@ See on <a href="nxcals-docs.web.cern.ch"> NXCALS Documentation</a>.
You need then to export 2 environment variables for Spark & Python.
-For linux (Ubuntu)
+For linux (Ubuntu tested)
``` bash
export SPARK_HOME=<location_of_the_bundle>/spark-<version>-bin-hadoop<version>
export PYTHONPATH=$SPARK_HOME/nxcals-python3-env/lib/python3.6/site-packages
```
-For windows into shell with admin rights
+For windows
+<br> Into shell with admin rights
```shell script
setx SPARK_HOME <location_of_the_bundle>/spark-<version>-bin-hadoop<version>
setx PYTHON_PATH %SPARK_HOME%/nxcals-python3-env/lib/python3.6/site-packages
@@ -38,7 +50,7 @@ the nxcals-hdoop-pro-config<version>.jar that you can find at
Know that all the links and directory path are up to date at the time of writing.
It may have been some updates since.
-After that you need to create a 'pyconf.py' file in order to create
+After that you need to create a `pyconf.py` file in order to create
mysql configuration. The template is :
```python
mysql = {
--
GitLab