PhoSim Use

This module is a high-level module to use PhoSim.

1. Platform

CentOS 7
python: 3.7.2
scientific pipeline (newinstall.sh from master branch)
phosim_syseng4 (branch: aos, tag: firstdonuts)

2. Needed Package

ts_wep - master branch (commit: 5d20039)
ts_ofc - master branch (commit: e38c4e1)
documenteer (optional)
plantuml (optional)
sphinxcontrib-plantuml (optional)

3. Use of Module

1. Setup the WEP and OFC environments first, and then, setup the PhoSim environment by eups:

cd $ts_phosim_directory
setup -k -r .
scons

2. Set the path variables:

export PHOSIMPATH=$path_to_phosim
export AOCLCOUTPUTPATH=$path_to_output

4. Example Script

calcOpd.py: Test the OPD without the subsystem perturbation.
calcOpdAndSubSys.py: Test the OPD with the subsystem perturbation.
checkStarAndSubSys.py: Test the star donut in LSST camera with the subsystem perturbation.
checkWfsStarCoor.py: Test to add the stars on WFS and get the images.
checkStarCoor.py: Test to add the star by pixel position and get the image.
checkStarCoorWiLsstFAM.py: Test to add the star by pixel position in LSST FAM condition and get the images.

5. Command Line Task

opdCloseLoop.py: Close-loop simulation in the optical path difference (OPD) level, which means the wavefront estimation pipeline (WEP) is not considered.
comcamCloseLoop.py: Close-loop simulation of commissioning camera. There are 9 stars on the center of each CCD. This task supports the amplifier images and eimages of PhoSim.

6. Build the Document

The user can use package-docs build to build the documentation. The packages of documenteer, plantuml, and sphinxcontrib-plantuml are needed. The path of plantuml.jar in doc/conf.py needs to be updated to the correct path. To clean the built documents, use package-docs clean. See Building single-package documentation locally for further details.

7. Reference of PhoSim with active optics (AOS)

The original work was done by Bo Xin and Chuck Claver. The source code can be found in: IM.

connolly/ts_phosim