EXPLAINSTIONS IN 'README.md'

README.md

@@ -1,6 +1,24 @@
 # BGO
+authors: Ava, Nicolas
+description: git repositpory of scripts for data analysis of experiments with large BGO
+---------------------------------------------------------------------------------------
+scripts are designed to be executed in the command line
+type 'scriptname.py -h' to see what the script does and what options are available
+---------------------------------------------------------------------------------------
+universal script 'AHBGOx.py' processes EI-data and stores results in '/histograms'
+figures will be saved in '/plots' 
+---------------------------------------------------------------------------------------
+DATA STORAGE
+EI-data is stored in '/net/asterix3/data/asterix/athena/arm/irena/ahbgo'
+The file 'README.txt' in the previous destination provides description to the data files
 
-scripts for data analysis of experiments with large BGO
+pressure and temperature data from vac-cham is stored in '/net/falbala/home/falbala/stephan/solo/spectra/dau'
 
-To DO
-Irgendwas
+histograms,Itime, dau(T_BGO) are beeing created using f.e. 'AHBGOx.py' and stored in '/histograms'. The foulder '/histograms/' is ignored by the git repository. Create data by yourself or copy 'net/asterix/home/asterix/ava/BGO/histograms/'
+--------------------------------------------------------------------------------------
+SYMLINK
+to avoid long file paths in the function call, symlinks to the storage locations are suitable
+
+example: 'ln -s /net/falbala/home/falbala/stephan/solo/spectra/dau/ dau'
+
+to see, where the symlink goes type 'readlink -f dau'

plot_tp.py

@@ -6,6 +6,7 @@ Created on Tue May 21 11:22:59 2024
 @author: Nicolas Rohrbeck
 Program to show a plot of Temp and (Pressure is broken atm!!!) against time. Needs to be modified to be more commonly usable.
 Calling syntax is: plot_tp.py -p FILE1 -T FILE2 -Tbgo FILE3
+data usually stored in /home/falbala/stephan/solo/spectra/dau
 """
 from matplotlib import pyplot as plt
 import argparse