As with all software packages, MAGIC has a list of known issues ranging from issues due to computer setup or other packages, to features in the package itself.
There have been some recent issues reported when trying to download MAGIC from GitLab.
One of the following might occur:
Comand line input:
git clone https://grit.stsci.edu/JWST-FGS/jwst-magic.git
xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun
In this case, you will need to download Xcode.
Please note that this must be solved differently depending on if you are cloning the repository from GitLab or GitHub. Please use the section that matches with your situation.
Command line input:
git clone [email protected]:JWST-FGS/jwst-magic.git
Cloning into 'jwst-magic'...
[email protected]: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights and the repository exists.
This error is telling you that either A) you don't have SSH keys set up, or B) the SSH keys you set up previously no longer work for some reason.
You can do one of the following:
A. Make sure you have SSH keys working: https://docs.gitlab.com/ee/ssh/#rsa-ssh-keys
B. Use https instead:
git clone https://grit.stsci.edu/JWST-FGS/jwst-magic.git
Note that this method will cause the following (non-fatal) error:
Fontconfig warning: ignoring UTF-8: not a valid region tag
Using backend: Qt5Agg
Downloading https://hpiers.obspm.fr/iers/bul/bulc/Leap_Second.dat
|==========================================| 1.3k/1.3k (100.00%) 0s
MAGIC version status cannot be checked due to the following issue: Warning: Permanently added the RSA host key for IP address '140.82.114.4' to the list of known hosts.
FGS COUNTRATE version status cannot be checked due to the following issue: [email protected]: Permission denied (publickey).`
Note: If you are cloning the GitHub repository, it is assumed that you are making changes to the repository since you cannot make changes to the repository from GitLab.
Command line input:
git clone [email protected]:spacetelescope/jwst_magic.git
Cloning into 'jwst-magic'...
[email protected]: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights and the repository exists.
This error is telling you that either A) you don't have SSH keys set up, or B) the SSH keys you set up previously no longer work for some reason.
Because STScI requires 2 factor authentication for GitHub, you must use SSH keys for cloning repositories from GitHub.
To solve this error you will have to make sure you have SSH keys working: https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
When installing MAGIC for the first time, some users have found that they get an error that traces back to the lxml package. At this moment, we have not been able to determine a permanent fix for this.
In your MAGIC environment, uninstall and reinstall lxml using pip:
$ pip uninstall lxml
$ pip install lxml
If MAGIC has been open for awhile, it will start to run very slowly.
In order to make sure MAGIC is still running fast, exit the GUI and exit out of IPython every 5-10 runs/configs. If you are running the GUI with a specific path to an image or out directory (i.e. when running a lot of tests), I recommend copying those locations to a Note or some other place so that you can quickly copy them back into the GUI once it has been started back up.
This is an issue that crops up every once in a while and the cause is not clear from the error message. Essentially you are getting this message because some wires have gotten crossed in the backend. This might happen if you switch branches without closing IPython or for other, less obvious reasons.
Quit the MAGIC GUI and close the IPython session by typing 'exit' in the terminal. Restart MAGIC:
$ ipython
In[1]: import jwst_magic
In[2]: jwst_magic.run_tool_GUI()
Some individuals have experienced the GUI crashing whenever a cancel button is pressed.
This behavior has been limited so no clear solution exists at this time. It is suggested that you quit your IPython session and restart the GUI.
When loading an input image in the main GUI, if you start writing the path before clicking "Open", it will not open to the path you have typed, and if you close the file window, the path will be deleted from the line input.
First click the Open button, when the dialog box appears, type "/" this will open the "Go To" window and you can type in your destination here.
For the case of an input image being in the FGS RAW frame (this is only expected in a testing case), MAGIC requires that the guider for the input image is the same as the output image.
Make any conversions ahead of time or simulate the image for the guider that you want.
Cannot create files for both guiders under the same "root" provided in the GUI. This is not allowed by the GUI.
If you need to switch guiders, remove the files in the directory in question or rename it if you anticipate needing to use those files for some reason. You can also run the GUI again using a different "root" by using the manual naming section.
When loading in a guiding selection file in the segment guiding section we currently get the locations and count rate, but for some CARs, we only really want to load the locations and not the count rates.
We have two different ways to load previous selections. One will override the count rates, the other will only use the locations that are loaded and the count rates of the image in question are used: A) Loading guiding selections files through the main GUI in the star selector section will load the PSF positions and count rates, B) Loading guiding selections files through the pop-out star selector GUI will load only the PSF positions