diff --git a/README.md b/README.md index 7fb58cf..49c1262 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,26 @@ # dispersiveXanes ```python +# INSTALL THE STUFF +# 1. Go in a folder where you will install the things (cd ~/my_folder) +# 2. git clone https://github.com/marcocamma/x3py.git +# 3. git clone https://git.ipr.univ-rennes1.fr/mcammara/dispersiveXanes.git + # BEFORE GETTING STARTED # 1. if at LCLS load the anaconda session # source ~marcoc/setups/ana-marco3k-setup.sh -# 2. start ipython -# ipython3 +# 2. go in the right folder (cd ~/my_folder/dispersiveXanes) +# → THIS IS IMPORTANT: change the experiment name in xanes_analyzeRun (line ~22) + +# GET STARTED +# 1. start ipython (ipython3) +# 2. tell python to use look for modules in the folder +# 3. import sys; sys.path.insert(0,"~/my_folder") # there are two files: -# 1. alignment.py (deals with images) +# 1. alignment.py (deals with images) # 2. xanes_analyzeRun.py (deals with run and images reading) -# the experiment name is defined in xanes_analyzeRun.py -# change to the right value before loading - %matplotlib nbagg import matplotlib import matplotlib.pylab as plt