Skip to content

Commit

Permalink
Doc updates (#30)
Browse files Browse the repository at this point in the history
* Add travis badge, instructions for contributing with issues

* fix MD urls to rst syntax

* re-word of legacy install to highlight python2.7 deps
  • Loading branch information
Justin Ely authored and jhunkeler committed Nov 2, 2016
1 parent 35a4b74 commit 9295811
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 16 deletions.
23 changes: 19 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,28 @@
Astroconda
##########

.. image:: http://readthedocs.org/projects/astroconda/badge/?version=latest
:target: http://astroconda.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://travis-ci.org/astroconda/astroconda.svg?branch=master
:target: https://travis-ci.org/astroconda/astroconda
:alt: CI Build Status

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.

Contributing and Issues
#######################
Please open a new issue or send us a pull request for bugs, feedback, questions, or enhancements.

* For documentation issues use the `astroconda issue tracker <https://github.com/astroconda/issue>`_
* For recipe issues, use the `astroconda-contrib issue tracker <https://github.com/astroconda-contrib/issue>`_


More Information
################

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
9 changes: 9 additions & 0 deletions source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Contributing Guide
Guidelines
==========

.. attention::

The following packaging guidelines are subject to change at any time.

- Please be respectful when commenting on pull-requests or issues.
Expand All @@ -21,6 +23,13 @@ Guidelines
- Abandoned recipes may be moved into the ``deprecated`` directory at any time without warning. (i.e. The package no longer compiles, has been obsoleted, or presents a conflict that cannot be resolved, etc).
- Packages derived from ``deprecated`` recipes will remain available in AstroConda for historical purposes (i.e. to preserve backwards compatibility).

Bugs, questions, and requests
=============================

Please open a new issue or send us a pull request for bugs, feedback, questions, or enhancements.

* For documentation issues use the `astroconda issue tracker <https://github.com/astroconda/issue>`_
* For recipe issues, use the `astroconda-contrib issue tracker <https://github.com/astroconda-contrib/issue>`_


Adding a recipe to astroconda-contrib
Expand Down
26 changes: 14 additions & 12 deletions source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Installation

Before you begin, the list below contains known requirements and limitations of AstroConda:

- This documentation targets Anaconda3 (i.e. Python 3)
- This documentation targets Anaconda3 (i.e. Python 3), but the installation instructions work equally well with any of the Anaconda distributions.
- AstroConda supports Linux (glibc ≥ 2.12) and Mac OS X (≥ 10.7; 10.6 is NOT supported)
- AstroConda contains packages for 64-bit [#archnote]_ Python 2.7 and 3.5.
- Conda only supports BASH and ZSH environments. If you are a native CSH user, execute ``bash -l`` prior to performing the procedures detailed in this guide.
Expand Down Expand Up @@ -66,8 +66,21 @@ This will prompt you to confirm the installation of all the STScI packages avail
Legacy Installation (with IRAF)
-------------------------------------


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, please visit the `PyRAF FAQ <http://www.stsci.edu/institute/software_hardware/pyraf/pyraf_faq>`_. If you are running Linux be sure to visit `this FAQ entry <faq.html#in-linux-how-do-i-install-iraf-s-32-bit-dependencies>`_ for a quick guide to installing IRAF's 32-bit dependencies.

.. attention::

Usage of IRAF currently requires running in a Python 2.7 environment.
The instructions below will install IRAF into a separate, Python 2.7,
environment regardless of your default Python version or which environments
you've created previously.

This will keep your IRAF environment separate from your other day-to-day
environments, which will facilitate updating only one or the other, and allow
easier transition off in the event of deprecation. Simply ``source activate iraf27``
for iraf work and ``source activate astroconda`` for day-to-day use.

.. code-block:: sh
$ conda create -n iraf27 python=2.7 iraf pyraf stsci
Expand All @@ -78,17 +91,6 @@ Then, just as with the default installation, it is necessary to activate the env
$ source activate iraf27
.. 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 both an ``astroconda`` environment with the default settings, and ``iraf27`` environment with IRAF.

.. code-block:: sh
$ conda create -n astroconda stsci
$ conda create -n iraf27 python=2.7 iraf pyraf stsci
Then, simply ``source activate astroconda`` for day-to-day use or ``source activate iraf27`` for work that requires IRAF. These two environments will be managed separately, allowing you to update only one or the other (see :doc:`updating`).

Fine-tuning the Installation
============================

Expand Down

0 comments on commit 9295811

Please sign in to comment.