miricoord

Code for MIRI Imager, LRS, and MRS distortion and coordinate transforms.

Includes scripts for generating pipeline CRDS distortion reference files from FITS, computing boresight offset tables, dither tables, etc.

Contents:

• IDL implementations of some code for backward compatibility live in the idl/ directory
• Python code lives in the miricoord/ directory
  • /general/: General utility functions (timers, logging tools, etc)
  • /imager/: Tools for the MIRI imager (including coronagraphs)
  • /lrs/: Tools for the MIRI low resolution spectrometer
  • /mrs/: Tools for the MIRI medium resolution IFU spectrometer
  • /tel/: Tools implementing the JWST attitude matrix transformations (v2/v3 to RA/DEC at a given roll angle)
• Reference data (FITS and CRDS) lives in the data/ directory

Installation:

Python:

Python code is developed for a python 3.7 environment. Clone this git repository to your local machine, and then install for your active conda environment by using:

python setup.py install

or

python setup.py develop

Using the 'install' option will copy the code over into your python library for the environment, while the 'develop' option will use the cloned code directory as the source. The 'develop' method is thus potentially easier to maintain if you might be updating or contributing to miricoord frequently.

Note that some functions rely upon having the pysiaf (https://github.com/spacetelescope/pysiaf) and JWST pipeline (https://github.com/spacetelescope/jwst) modules installed as well.

Some routines are configured to write files to a specific set of subdirectories on disk (when, e.g., generating new reference files). The base directory for these should be set as:

setenv MIRICOORD_DATA_DIR /YourDataPathHere/

If this is not set, these files will default to writing out in your current working directory.

IDL:

Note that the IDL code contained here is no longer under active development and is retained only for legacy purposes. IDL code is developed for IDL 8.0 and requires that the global system variable $MIRICOORD_DIR be defined and pointing to the root directory of this product, and that it be included on the search path. This is necessary so that the code can find the relevant reference files.

E.g., setenv MIRICOORD_DIR /YourPathHere/miricoord setenv IDL_PATH ${IDL_PATH}:+$MIRICOORD_DIR

Dependencies:

• Some python tools depend on the pysiaf package (https://github.com/spacetelescope/pysiaf) for interaction with the MIRI SIAF
• Some python tools depend on the JWST calibration pipeline (https://github.com/spacetelescope/jwst)