Skip to content

Commit

Permalink
Merge pull request #10 from justincely/master
Browse files Browse the repository at this point in the history
RTD and PyRAF FAQ links
  • Loading branch information
jhunkeler committed Jun 13, 2016
2 parents 22b799d + 64f190b commit 4ad1181
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 3 deletions.
13 changes: 13 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Astroconda
##########

AstroConda is a free software repository maintained by the Space Telescope
Science Institute (STScI) in Baltimore, Maryland. This repository provides tools
and utilities commonly used by the astronomical community.

See the `full documentation <http://astroconda.readthedocs.io/en/latest/>`_ for
additional information.

.. image:: http://readthedocs.org/projects/astroconda/badge/?version=latest
:target: http://astroconda.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
14 changes: 11 additions & 3 deletions source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,12 @@ This will prompt you to confirm the installation of all the STScI packages avail
Installation with legacy IRAF support
-------------------------------------

The developers of AstroConda have limited resources to support :abbr:`IRAF (Image Reduction and Analysis Facility)`, but users that require the ability to run IRAF and PyRAF tasks may want to install it through AstroConda.
The developers of AstroConda have limited resources to
support :abbr:`IRAF (Image Reduction and Analysis Facility)`, but users that
require the ability to run IRAF and PyRAF tasks may want to install it
through AstroConda. For help with many issues that come up during installation
or use, visit the `PyRAF FAQ <http://www.stsci.edu/institute/software_hardware/pyraf/pyraf_faq>`_
page.

IRAF is not installed by default, so the AstroConda install command is a little different.

Expand All @@ -85,7 +90,11 @@ Then, just as with the default installation, it is necessary to activate the env
.. note::

Support for using Python 2.7 and IRAF is being gradually phased out by STScI maintainers. In the transitional period, you may wish to install AstroConda with the default settings but maintain a Python 2.7 + IRAF environment for testing. The following commands create an ``astroconda`` environment with the default settings, and an ``iraf27`` environment with IRAF.
Support for using Python 2.7 and IRAF is being gradually phased out by STScI
maintainers. In the transitional period, you may wish to install AstroConda
with the default settings but maintain a Python 2.7 + IRAF environment for
testing. The following commands create an ``astroconda`` environment with
the default settings, and an ``iraf27`` environment with IRAF.

.. code-block:: sh
Expand Down Expand Up @@ -124,4 +133,3 @@ The Python-standard tool ``pip`` is also available to install packages distribut
$ source activate astroconda
$ pip install nameofpkg
3 changes: 3 additions & 0 deletions source/resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ Space Telescope Science Institute

- `help@stsci.edu <mailto:help@stsci.edu>`_

**PyRAF FAQ**

- http://www.stsci.edu/institute/software_hardware/pyraf/pyraf_faq

Gemini Observatory
==================
Expand Down

0 comments on commit 4ad1181

Please sign in to comment.