summaryrefslogtreecommitdiff
path: root/source/installation.rst
blob: 38560c8a3d0701f29fd5c5fbca7f49bfa5404150 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
############
Installation
############

.. admonition:: Keep the following in mind

    - AstroConda supports Linux (>=glibc-2.12) and OS X (>= 10.7; 10.6 is NOT supported); Running Python 2.7, 3.4, or 3.5.
    - If IRAF is required as part of your personal workflow it is *highly recommended* you install Anaconda2 (`FAQ <faq.html#why-is-iraf-pyraf-less-functional-under-python-3>`_).
    - Otherwise choose the Anaconda installer best suited for your scripting needs.
    - This documentation specifically targets Anaconda3 installations. However, the same commands should still work interchangeably between versions.

Obtain Anaconda
===============

Go grab a copy of the `Anaconda <https://www.continuum.io/downloads>`_ distribution from Continuum, Inc. Be sure to select
the installation medium appropriate for your operating system and architecture.

Installation instructions for your platform are also available on the download page.


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.

.. code-block:: sh

    $ conda config --add channels http://ssb.stsci.edu/astroconda
    # Writes changes to ~/.condarc


Install AstroConda
==================

Now that Conda is configured to pull from our repository, you may now go ahead and install the ``stsci`` metapackage.
The example below will generate a new environment called "astroconda" (using the ``-n`` flag),
however, this is merely a suggestion. Feel free to use a name that works best for you.

.. code-block:: sh

    $ conda create -n astroconda stsci
    $ source activate astroconda


Fine-tuning the installation
============================

If you are short on hard drive space, have a slow internet connection, or are simply not interested in installing
*everything but the kitchen sink*; please feel free to peruse the `manifest <http://ssb.stsci.edu/astroconda>`_ and
install a custom mix of packages *tailored to your needs*.

.. code-block:: sh

    $ conda create -n astroconda [package [package ...]]
    $ source activate astroconda