Skip to content

Commit

Permalink
Merge pull request #171 from spacetelescope/update_readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
RemiSoummer authored Apr 5, 2024
2 parents c866f66 + 04d0703 commit 7663307
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
The Control and Automation for Testbeds Kit 2 (CATKit2)
---------------------
CATKit2 is a toolkit for hardware controls that has been developed at the Space Telescope Science Institute.
It provides a general infrastructure to control hardware and synchronize devices.

This package was developed for use on the High-contrast Imager for Complex Apertures Testbed (HiCAT) for
developing technologies relevant to direct imaging of exoplanets in astronomy in the laboratory.

This is an open-source package, but it is not actively supported. Use at your own risk.

Environment variables
---------------------

Set `FOR_DISABLE_CONSOLE_CTRL_HANDLER` to `1`. This disables the Fortran Ctrl+C hander, and avoids crashing of the Python program upon receiving on a Keyboard interrupt. This is necessary if you import scipy, which uses Fortran modules.

On Windows, you can set environment variables for your account only from the control panel, which doesn't require administrator rights.

On MacOS, assuming a bash shell (the standard choice for hicat work) this is done by adding the following line at the end of your .bash_profile file:
On MacOS, assuming a bash shell this is done by adding the following line at the end of your .bash_profile file:
```
export FOR_DISABLE_CONSOLE_CTRL_HANDLER=1
```
Expand Down

0 comments on commit 7663307

Please sign in to comment.