summaryrefslogtreecommitdiff
path: root/source/installation.rst
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@users.noreply.github.com>2017-01-23 20:03:38 -0500
committerGitHub <noreply@github.com>2017-01-23 20:03:38 -0500
commit89e5e79e22d4de3ed27a540f29df7bbd2660f359 (patch)
tree86008c192ee5634a5996caa8019743fb2596ae47 /source/installation.rst
parentc0c3f123a674f38e3a569b6ab5058c6384709ff4 (diff)
downloadastroconda-89e5e79e22d4de3ed27a540f29df7bbd2660f359.tar.gz
Clarity (#38)
* Initial commit of compatibility notices page; added to index * Replace references to Anaconda with Miniconda * Add pipeline release description * We no longer keep things like new. We update them. * Use more targeted wording * Replace or enhance references to anaconda with miniconda, or just conda depending on context * Reword/improve config section
Diffstat (limited to 'source/installation.rst')
-rw-r--r--source/installation.rst32
1 files changed, 20 insertions, 12 deletions
diff --git a/source/installation.rst b/source/installation.rst
index 871d917..45b4d23 100644
--- a/source/installation.rst
+++ b/source/installation.rst
@@ -4,41 +4,48 @@ Installation
Before you begin, the list below contains known requirements and limitations of AstroConda:
- - This documentation targets Anaconda3 (i.e. Python 3), but the installation instructions work equally well with any of the Anaconda distributions.
+ - This documentation targets Miniconda3 (i.e. Python 3), but the installation instructions work equally well with any of the Miniconda 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.
- - IRAF users: After configuring Anaconda for use with AstroConda, refer to the :ref:`iraf_install` section of this guide to continue your installation.
+ - IRAF users: After configuring Miniconda for use with AstroConda, refer to the :ref:`iraf_install` section of this guide to continue your installation.
-Obtain Anaconda
-===============
+Obtain Miniconda
+================
.. note::
- Installing Anaconda3 will not prevent you from using Python 2.
-
- ``conda`` allows you to deploy multiple independent Python environments, at-will, under a single Anaconda installation. You may have trouble following along with this guide if you choose to install Anaconda2.
+ Installing Miniconda3 will not prevent you from using Python 2.
+ ``conda`` allows you to deploy multiple independent Python environments, at-will, under a single Miniconda installation. You may have trouble following along with this guide if you choose to install Miniconda2.
-Go grab a copy of `Anaconda3 <https://www.continuum.io/downloads>`_ from Continuum Analytics, Inc. Be sure to select the installation medium appropriate for your operating system (Linux or OS X) and architecture (64-bit). The OS X GUI installer may cause side-effects, such as changing permissions of files in your home directory to ``root:wheel``, or mistakenly creating a system-wide installation under ``/anaconda`` instead of your personal home directory. To avoid this situation perform a command-line installation instead.
-Follow the installation instructions for your platform provided on the download page. Before moving on to the next step, open a new terminal window, and run ``conda`` to verify your terminal session can find it.
+Go grab a copy of `Miniconda3 <http://conda.pydata.org/miniconda.html>`_ from Continuum Analytics, Inc. Be sure to select the installation medium appropriate for your operating system (Linux or OS X) and architecture (64-bit). Follow the installation instructions for your platform provided on the download page. Before moving on to the next step, open a new terminal window, and run ``conda`` to verify your terminal session can find it.
Configure Conda
===============
-In order to install packages directly from the AstroConda repository, you will need to configure Anaconda to do so. This will permanently add the repository to Conda's search path. Be aware that adding additional `anaconda.org <https://anaconda.org>`_ or direct-url repositories may affect the stability of AstroConda's run-time environment.
+In order to install packages directly from the AstroConda repository, you will need to configure Conda to do so.
.. code-block:: sh
$ conda config --add channels http://ssb.stsci.edu/astroconda
# Writes changes to ~/.condarc
+This command will append the AstroConda channel URL to Conda's channel search path. Be aware that adding additional `anaconda.org <https://anaconda.org>`_ or direct-url repositories can potentially effect thestability of AstroConda's run-time environment.
+
+For example, if you add a channel found on anaconda.org because it contains a software package you're interested in, but also provides the same software as AstroConda, it's possible you may lose track of where packages are coming from. If you decide to have multiple channels defined in your configuration and bugs begin to appear, it may be best to check their origin before issuing a support ticket to help@stsci.edu. ``conda list`` can be used to display such information about the packages installed in your environment.
+
Install AstroConda
==================
+.. caution::
+
+ If you wish to install a copy of a mission-specific operational data processing environment, please `click here <releases.html>`_.
+
+
Standard Installation (without IRAF)
------------------------------------
@@ -91,6 +98,7 @@ Then, just as with the default installation, it is necessary to activate the env
$ source activate iraf27
+
Fine-tuning the Installation
============================
@@ -108,14 +116,14 @@ AstroConda provides a suite of packages that are known to work well together and
Full documentation of the ``conda`` tool is available from Continuum Analytics, Inc., its creators and maintainers: http://conda.pydata.org/docs/using/index.html. However, we have provided a brief explanation of 3rd-party package installation below for quick reference.
-For scientific packages available through Anaconda, installation is as simple as:
+For scientific packages available through Miniconda, installation is as simple as:
.. code-block:: sh
$ source activate astroconda
$ conda install name_of_pkg
-Often, the easiest way to see if the package is available through Anaconda is to try installing it. The full list of available packages is here: http://repo.continuum.io/pkgs/.
+Often, the easiest way to see if the package is available through Miniconda is to try installing it. The full list of available packages is here: http://repo.continuum.io/pkgs/.
The Python-standard tool ``pip`` is also available to install packages distributed through the Python Package Index (PyPI):