[SIM2D-121] Update 2D simulator documentation Created: 15/Oct/19  Updated: 12/Nov/19  Resolved: 12/Nov/19

Status: Done
Project: DRP 2-D Simulator
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Story Priority: Normal
Reporter: hassan Assignee: hassan
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Story Points: 2
Sprint: 2DDRP-2019 H, 2DDRP-2019 I
Reviewers: Masayuki Tanaka

 Description   

The user documentation for the simulator is a little out-of-date (the makeSim invocation steps for example) and requires updating.



 Comments   
Comment by hassan [ 25/Oct/19 ]

Hi Masayuki Tanaka can you have a look at my changes and give me feedback (to build from a clone of the git repo, use make latexpdf and open the pdf under the _build directory.

Comment by Masayuki Tanaka [ 30/Oct/19 ]

It turned out that all of my comments are outside of the text regions where you made changes.  So, here they are.  They are all minor and should be pretty straightforward to implement.

  • Features of the simulator:
    • In the bullets at the top, I think we can add 'sky spectra'.  We then need to add a short section below about the sky spectra.  I think just 2-3 sentences summarizing where the spectra come from and assumptions employed there would be sufficient.  Do we assume airmass=1 with no moon?
    • It would be useful to mention that we can simulate the blue and red arms, but not NIR arms, somewhere in this section.  Perhaps just below the bullets?
  • Using the simulator:
    • Section 4.2 gives a list of options for makeSim.  One of the options is '–imagetyp', and I think it would be useful to list the available image types here.

I think that is it.  Let me know if anything here is unclear.  I did not run the commands in the document myself, but I can do that if needed.  Let me know.

Comment by hassan [ 31/Oct/19 ]

I've pushed updates based on your comments. Regarding the sky spectrum, Jim Gunn has no further recollection as to what other assumptions have been made. I will contact Yabe-san to see if he is aware of more.

Comment by Kiyoto Yabe [ 31/Oct/19 ]

The performance document (https://sumire.pbworks.com/w/file/fetch/129441444/PFS-GEN-IPM003001-01_pfs_expected_performance_KYabe_20170731.pdf), especially section 3.2.3, may be useful for the assumptions in sky spectrum.

Comment by hassan [ 11/Nov/19 ]

Document updated Masayuki Tanaka. Can you check please?

Comment by Masayuki Tanaka [ 12/Nov/19 ]

The changes look good to me.

Generated at Sat Feb 10 16:08:47 JST 2024 using Jira 8.3.4#803005-sha1:1f96e09b3c60279a408a2ae47be3c745f571388b.