"Simple" example using romanisim-make-image for docs

[bmorris3]

In learning to use romanisim, I found that the Running the simulation page in the docs explains the arguments, but does not have examples.

Users want/will want to have a reproducible usage example in the docs, so I've added one here.

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (a6a8ecd) 90.00% compared to head (da99dc0) 90.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #57   +/-   ##
=======================================
  Coverage   90.00%   90.00%           
=======================================
  Files          15       15           
  Lines        1351     1351           
=======================================
  Hits         1216     1216           
  Misses        135      135           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[schlafly]

Looks good to me; feel free to merge you're ready. For this particular case one could imagine calling romanisim.image.simulate(...) directly, without the romanisim-make-image wrapper, but this is a nice approach as well, and doubles as a demo of the CLI.

[bmorris3]

The motivation for using the CLI version in the above script instead of simulate, was really that there are a bunch of tasks that the CLI version takes care of for you, which I wanted to avoid duplicating:

romanisim/scripts/romanisim-make-image

Lines 62 to 92 in a6a8ecd

	if args.radec is not None:
	coord = SkyCoord(ra=args.radec[0] * u.deg, dec=args.radec[1] * u.deg,
	frame='icrs')
	wcs.fill_in_parameters(metadata, coord, boresight=args.boresight)
	if args.date is not None:
	metadata['exposure']['start_time'] = Time(
	datetime.datetime(*args.date)).isot
	date = Time(metadata['exposure']['start_time'], format='isot')
	metadata['instrument']['detector'] = f'WFI{args.sca:02d}'
	metadata['instrument']['optical_element'] = args.bandpass
	metadata['exposure']['ma_table_number'] = args.ma_table_number
	if args.catalog is None:
	twcs = wcs.get_wcs(metadata, usecrds=args.usecrds)
	rd_sca = twcs.toWorld(galsim.PositionD(
	galsim.roman.n_pix / 2, galsim.roman.n_pix / 2))
	cat = catalog.make_dummy_table_catalog(
	rd_sca, bandpasses=[args.bandpass], nobj=args.nobj)
	else:
	log.warning('Catalog input will probably not work unless the catalog '
	'covers a lot of area or you have thought carefully about '
	'the relation between the boresight and the SCA locations.')
	cat = Table.read(args.catalog)
	if args.previous is not None:
	persist = persistence.Persistence.read(args.previous)
	else:
	persist = persistence.Persistence()

It may be worthwhile to prevent users from kicking the can down the road on learning these necessary inputs though, especially for this doc example. I'll edit with simulate!

[bmorris3]

@schlafly This updated version uses simulate rather than the unnecessary check_call.

[schlafly]

Looks good to me. A few minor things you could drop that I think were part of the previous implementation.

[schlafly]

I think this is vestigial?

[schlafly]

I think this is vestigial?

[schlafly]

I think you could drop this, and show im['data'] below instead of asdf_file.tree['roman']['data'].