Skip to content

Commit 7663307

Browse files
authored
Merge pull request #171 from spacetelescope/update_readme
Update readme
2 parents c866f66 + 04d0703 commit 7663307

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
1+
The Control and Automation for Testbeds Kit 2 (CATKit2)
2+
---------------------
3+
CATKit2 is a toolkit for hardware controls that has been developed at the Space Telescope Science Institute.
4+
It provides a general infrastructure to control hardware and synchronize devices.
5+
6+
This package was developed for use on the High-contrast Imager for Complex Apertures Testbed (HiCAT) for
7+
developing technologies relevant to direct imaging of exoplanets in astronomy in the laboratory.
8+
9+
This is an open-source package, but it is not actively supported. Use at your own risk.
10+
111
Environment variables
212
---------------------
313

414
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.
515

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

8-
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:
18+
On MacOS, assuming a bash shell this is done by adding the following line at the end of your .bash_profile file:
919
```
1020
export FOR_DISABLE_CONSOLE_CTRL_HANDLER=1
1121
```

0 commit comments

Comments
 (0)