diff --git a/README.md b/README.md deleted file mode 100644 index c47b14b..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -# EPSim \ No newline at end of file diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..d5f6676 --- /dev/null +++ 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/ +