Skip to content

Commit 65bdbf7

Browse files
committed
Activating instructions
1 parent c146f47 commit 65bdbf7

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

doc/source/index.rst

+35
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,41 @@ For making quick plots and getting quick summaries of important information, the
1010
following ACISpy-based command-line utilities are provided. For finer-grained
1111
control over plots and data, it is recommended to use the ACISpy Python interface.
1212

13+
Activating
14+
----------
15+
16+
The ACISpy command-line tools are installed into the ACIS Ops Ska Python stack.
17+
If you are logged on as ``acisdude``, all you need to do is issue the
18+
command ``acisska`` and this Python stack and the tools will be loaded into
19+
your environment.
20+
21+
However, if you would like activate this stack and these tools from your own user
22+
account, add the following alias to your ``.bashrc`` if you are using the Bash
23+
shell (or a variant):
24+
25+
.. code-block:: bash
26+
27+
acisska () {
28+
PATH=/data/acis/ska/bin:$PATH
29+
export SKA=/proj/sot/ska
30+
PS1="[ska3:\u@\h \W]\$ "
31+
}
32+
33+
Or, if you are a mascohist or are otherwise compelled to use the C shell or a
34+
variant of it, add this alias to your ``.cshrc.user``:
35+
36+
.. code-block:: bash
37+
38+
alias acisska 'set path = (/data/acis/ska/bin/ $path); \
39+
setenv SKA /proj/sot/ska; \
40+
set prompt = "[acisska] $prompt"'
41+
42+
.. warning::
43+
44+
The ACIS Ops Ska Python stack should be used in a "clean" terminal window
45+
where you are not trying to do anything else (i.e., load reviews, SACGS)
46+
as setting up the Ska environment messes with environment variables and paths.
47+
1348
``multiplot_archive``
1449
---------------------
1550

0 commit comments

Comments
 (0)