Request for tutorial on integration with HCIPy

[Jashcraf]

This issue is part of my JOSS review: openjournals/joss-reviews#7917

In the software paper, the following claim is made

‘PyStarshade’ optionally interfaces with HCIPy (Por et al., 2018) to generate telescope apertures and the resulting imaging in a streamlined fashion.

This is an cool feature that is worth highlighting in either the examples or the readthedocs. Could a tutorial be added showing how to use the HCIPy apertures in PyStarshade?

Also, I see that apodization/pupil.py calls the various HCIPy aperture generators:

PyStarshade/pystarshade/apodization/pupil.py

Lines 12 to 28 in 0bfc46c

	aperture_funcs = {
	'circ': make_circular_aperture,
	'ELT': make_elt_aperture,
	'GMT': make_gmt_aperture,
	'TMT': make_tmt_aperture,
	'Hale': make_hale_aperture,
	'LUVOIR-A': make_luvoir_a_aperture,
	'LUVOIR-B': make_luvoir_b_aperture,
	'Magellan': make_magellan_aperture,
	'VLT': make_vlt_aperture,
	'HiCAT': make_hicat_aperture,
	'HabEx': make_habex_aperture,
	'HST': make_hst_aperture,
	'JWST': make_jwst_aperture,
	'Keck': make_keck_aperture,
	'hex': custom_hex
	}

But I'm not clear on what "the resulting imaging in a streamlined fashion" refers to. Can PyStarshade export simulated images to HCIPy's Wavefront or Field object?

[xiaziyna]

Here I am using the sentence: 'PyStarshade’ optionally interfaces with HCIPy (Por et al., 2018) to generate telescope apertures and the resulting imaging in a streamlined fashion.' to mean that PyStarshade will call/load apertures into the starshade simulator without needing to go and download these masks/figure out sampling manually! I can see how this wording implies downstream coronagraph simulation. This is the extent of the integration with HCIPy. I have revised the sentence to omit 'in a streamlined fashion'.

To address a demo of this, as well as Issue #9, I've created a notebook with a simple example - generating a PSF for a 60m starshade, for two different telescope apertures (one showing an supplied npz file mask and the other using hcipy).
https://pystarshade.readthedocs.io/en/latest/content/solar_system.html

[Jashcraf]

This is a superb demo!