modified the README

lcmd-epfl · Jul 23, 2020 · 827693e · 827693e
1 parent fbea05f
commit 827693e
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,23 @@
+EPSim
+============
+Energy Profile Similarity Maps
+
+EPsim is a python program that allows to construct the Energy Profile Similarity maps, based on a de.
+
+Requirements
+------------
+* Python_ 3.5 or later
+* Anaconda_ 3
+
+Installation
+------------
+Add ``~/EPSim`` to your $PYTHONPATH environment variable.
+
+Example
+-------
+python  epsim.py -i ./example\_data/mydata.txt -f 1,2,3,4,5,6 -r -30.738 -s 6 -d ./example\_data/descript.dat -c 1
+
+
+.. _Python: http://www.python.org/
+.. _Anaconda : https://www.anaconda.com/
+