Difference between revisions of "TEA-phot"

From SAAO TOPS Wiki
Jump to: navigation, search
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
==Installation Instructions==
 
==Installation Instructions==
(These instructions should be identical for a Linux or Mac environment and a minimum system requirement is Python 3.7 or later)
+
'''NB. If you use the TEA-Phot code to produce results for a scientific publication, we ask that you please adhere to the citation requests of the developers that are on their main repository page (link below).'''
  
  
 +
*These instructions should be identical for a Linux or Mac environment and Python 3.7 or a later version is recommended.
 
*TEA-Phot can be directly downloaded from [https://bitbucket.org/DominicBowman/tea-phot here] or the repository can quickly be cloned through the following command in the terminal:
 
*TEA-Phot can be directly downloaded from [https://bitbucket.org/DominicBowman/tea-phot here] or the repository can quickly be cloned through the following command in the terminal:
 
  git clone https://bitbucket.org/DominicBowman/tea-phot.git
 
  git clone https://bitbucket.org/DominicBowman/tea-phot.git
Note: If you use the TEA-Phot code to produce results for a scientific publication, we ask you to please adhere to the citation requests of the developers that are on their main repository page (link above).
 
 
 
* TEA-Phot requires only four additional Python modules. To install (if not already) run the following command in the terminal:
 
* TEA-Phot requires only four additional Python modules. To install (if not already) run the following command in the terminal:
 
  pip3 install numpy matplotlib sep astropy
 
  pip3 install numpy matplotlib sep astropy
  
 
=="How-to" Instructions and Tips==
 
=="How-to" Instructions and Tips==
(NB: TEA-phot currently only supports SHOC data (incl. flats and bias files) in a cube format)
+
'''NB. TEA-phot currently only supports SHOC data (incl. flats and bias files) in a cube format.'''
 +
 
  
 
* To reduce and extract photometry from SHOC using TEA-phot, in the terminal navigate to the folder that contains the '''TEA-Phot.py''' file.
 
* To reduce and extract photometry from SHOC using TEA-phot, in the terminal navigate to the folder that contains the '''TEA-Phot.py''' file.
Line 18: Line 18:
 
* A typical example to reduce and extract photomery from SHOC data would be something like this:
 
* A typical example to reduce and extract photomery from SHOC data would be something like this:
 
  python3 TEA-Phot.py SAAO SHOC name_of_data_cube.fits --image_dir /path/to/data_cube/ --flat name_of_flat_cube.fits --flat_dir /path/to/flat_cube/ --bias name_of_bias_cube --bias_dir /path/to/bias_cube/ --out_dir /path/to/output_files_plots/ --do_plot True --source_sigma 2.0
 
  python3 TEA-Phot.py SAAO SHOC name_of_data_cube.fits --image_dir /path/to/data_cube/ --flat name_of_flat_cube.fits --flat_dir /path/to/flat_cube/ --bias name_of_bias_cube --bias_dir /path/to/bias_cube/ --out_dir /path/to/output_files_plots/ --do_plot True --source_sigma 2.0
* Follow the prompts for pipeline's instructions and inputs in the terminal.
+
* Wait for window to appear and select target and comparison star with mouse-clicks.
 +
* Follow further prompts from the pipeline for inputs (aperture size etc.) in the terminal.
 +
 
 
Note: TEA-phot will NOT do bias and flat field corrections if not BOTH flat AND bias cubes are supplied.
 
Note: TEA-phot will NOT do bias and flat field corrections if not BOTH flat AND bias cubes are supplied.

Latest revision as of 20:39, 6 August 2020

Installation Instructions

NB. If you use the TEA-Phot code to produce results for a scientific publication, we ask that you please adhere to the citation requests of the developers that are on their main repository page (link below).


  • These instructions should be identical for a Linux or Mac environment and Python 3.7 or a later version is recommended.
  • TEA-Phot can be directly downloaded from here or the repository can quickly be cloned through the following command in the terminal:
git clone https://bitbucket.org/DominicBowman/tea-phot.git
  • TEA-Phot requires only four additional Python modules. To install (if not already) run the following command in the terminal:
pip3 install numpy matplotlib sep astropy

"How-to" Instructions and Tips

NB. TEA-phot currently only supports SHOC data (incl. flats and bias files) in a cube format.


  • To reduce and extract photometry from SHOC using TEA-phot, in the terminal navigate to the folder that contains the TEA-Phot.py file.
  • To display basic usage and optional arguments run:
python3 TEA-Phot.py -h
  • A typical example to reduce and extract photomery from SHOC data would be something like this:
python3 TEA-Phot.py SAAO SHOC name_of_data_cube.fits --image_dir /path/to/data_cube/ --flat name_of_flat_cube.fits --flat_dir /path/to/flat_cube/ --bias name_of_bias_cube --bias_dir /path/to/bias_cube/ --out_dir /path/to/output_files_plots/ --do_plot True --source_sigma 2.0
  • Wait for window to appear and select target and comparison star with mouse-clicks.
  • Follow further prompts from the pipeline for inputs (aperture size etc.) in the terminal.

Note: TEA-phot will NOT do bias and flat field corrections if not BOTH flat AND bias cubes are supplied.