summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@users.noreply.github.com>2016-06-13 12:57:49 -0400
committerGitHub <noreply@github.com>2016-06-13 12:57:49 -0400
commit4ad11813c69f7ced3063bc341bd412b37820ace0 (patch)
treea2e76c00b6453827814edb3127bdd9895bf3a834
parent22b799d0b97e2e580579062821a02402ccb02e6f (diff)
parent64f190ba5261c255b85549c76742b5ba1aa15526 (diff)
downloadastroconda-4ad11813c69f7ced3063bc341bd412b37820ace0.tar.gz
Merge pull request #10 from justincely/master0.0.1
RTD and PyRAF FAQ links
-rw-r--r--README.rst13
-rw-r--r--source/installation.rst14
-rw-r--r--source/resources.rst3
3 files changed, 27 insertions, 3 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..d036bb9
--- /dev/null
+++ b/README.rst
@@ -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
diff --git a/source/installation.rst b/source/installation.rst
index b4029c5..a8b0ec1 100644
--- a/source/installation.rst
+++ b/source/installation.rst
@@ -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.
@@ -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
@@ -124,4 +133,3 @@ The Python-standard tool ``pip`` is also available to install packages distribut
$ source activate astroconda
$ pip install nameofpkg
-
diff --git a/source/resources.rst b/source/resources.rst
index 41e4201..8c37baf 100644
--- a/source/resources.rst
+++ b/source/resources.rst
@@ -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
==================