Inspired by emccd_detect and the MKID Pipeline, for a given input flux map mkid_detect will return either an image or a simulated MKID photon list saved to an HDF5 file.
MKID data by nature can be quite memory intensive so caution should be taken to ensure memory issues are not encountered.
mkid_detect is available on the PyPI repository and can be installed by running:
pip install mkid_detect
Start by cloning the repository:
git clone [email protected]:steigersg/mkid_detect.git
Then run
pip install .
If you would like to edit or modify the package use the -e flag as:
pip install -e .
There are two main ways to interact with MKIDDetect: The sim_output function and the sim_output_image
function.
will generate time and wavelength tagged photon lists similar to the outputs of an actual MKID detector.
Will output a single integrated image which, by nature, marginalizes over all the timing information available to MKIDs but is much less time and memory intensive if just an image is desired.