Skip to content

README.md

Latest commit

 

History

History
51 lines (33 loc) · 1.28 KB

README.md

File metadata and controls

51 lines (33 loc) · 1.28 KB

Installation and setup

Required softwares

Setting up the environment

Set the environment in your .bashrc or .bash_profile:

function Xgam_env {
	echo 'Setting Xgam environment...'
	conda activate fermi
	export PYTHONPATH=:/path/to/this/package/:${PYTHONPATH}
 	export PATH=/path/to/this/package/Xgam/bin:${PATH}
	export P8_DATA=/path/to/data_files
	echo 'done.'}

Change the directory where the data files are stored in init.py (line 35):

FT_DATA_FOLDER = '/path/to/data_files'

In the data directory should there be the following folders:

  • photon/ -> where FT1 files are stored
  • spacecraft/ -> where FT2 files are stored
  • output/ -> where ST outputs will be stored

Docker alternative

See the dedicated wiki page.

How to run the analysis

This will show all the possible settings of a given function in bin/ :

 python bin/mkAnyFunction.py -h

Some more details can be found in the Wiki of this project:

https://github.com/nmik/Xgam/wiki

(A more detailed documentation will be soon available).