Skip to content

Commit

Permalink
Remove typewriter style returns. Slight wording changes. Update manif…
Browse files Browse the repository at this point in the history
…ests.
  • Loading branch information
jhunkeler committed Aug 19, 2016
1 parent 4ad1181 commit f2806db
Show file tree
Hide file tree
Showing 8 changed files with 746 additions and 544 deletions.
94 changes: 33 additions & 61 deletions source/contributing.rst

Large diffs are not rendered by default.

60 changes: 20 additions & 40 deletions source/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,27 @@ F.A.Q.
######


After "``conda create ...``" why does "``source activate astroconda``" fail?
After "conda create -n ..." why does "source activate astroconda" fail?
============================================================================

Anaconda does not support CSH (C-Shell). Please switch to a POSIX-compatible shell (e.g. BASH, KSH, ZSH).

.. note::

STScI will not maintain a separate codebase of Anaconda's backend ``conda`` in order to implement CSH support. Feel free to
create an issue with the `developers <http://github.com/conda/conda/issues>`_.
STScI will not maintain a separate codebase of Anaconda's backend ``conda`` in order to implement CSH support. Feel free to create an issue with the `developers <http://github.com/conda/conda/issues>`_.

I installed AstroConda into my Anaconda 'root' environment. What now?
=====================================================================

Please reinstall Anaconda from scratch. AstroConda uses ``source activate`` and ``source deactivate`` calls to control your shell
environment. The Anaconda 'root' environment **does not** use this feature, and thus, the packages you have installed there will not work properly.
To clarify, it is impossible to execute ``source activate root``. Installing AstroConda packages directly into the 'root' may cause
Anaconda itself to be come unstable. In addition to this, removing packages from this environment is tedious and will likely break
your Anaconda installation if you are not careful. *Reinstalling from scratch is the safest option.*
Please reinstall Anaconda from scratch. AstroConda uses ``source activate`` and ``source deactivate`` calls to
control your shell environment. The Anaconda 'root' environment **does not** use this feature, and thus, the packages you have installed there will not work properly.

To clarify, it is impossible to execute ``source activate root``. Installing AstroConda packages directly into the 'root' may cause Anaconda itself to be come unstable. In addition to this, removing packages from this environment is tedious and will likely break your Anaconda installation if you are not careful. *Reinstalling from scratch is the safest option.*

Why am I being prompted by NumPy/SciPy with a MKL 30-day trial warning?
=======================================================================

The ``root`` environment of your Anaconda installation is severely outdated (``<=2.4.0``) and suffers from a crippling bug
introduced by the ``conda-3.19.x`` package.
The ``root`` environment of your Anaconda installation is severely outdated (``<=2.4.0``) and suffers from a crippling bug introduced by the ``conda-3.19.x`` package.

It is possible to verify the version of Anaconda you have by running:

Expand All @@ -50,47 +47,34 @@ Next, update the ``astroconda`` environment to realign your packages with the ``
$ source activate astroconda
After doing this, the ``mkl`` 30-day trial warning will not be displayed while importing ``numpy``, ``scipy``, or any
other package requiring ``mkl``.
other package requiring ``mkl``.

How does AstroConda differ from Ureka?
======================================

Ureka and AstroConda both provide applications and libraries in binary form, however Ureka was a *one size fits all* distribution
which included every package in one giant tarball. If an end-user only really wanted a small set of packages they were forced
to install everything *and then some*. AstroConda is a *if the shoe fits wear it* distribution of packages. If an end-user
needs ``HSTCAL``, for example, they can install ``HSTCAL`` and omit much of the rest of HST's software suite.
Ureka and AstroConda both provide applications and libraries in binary form, however Ureka was a *one size fits all* distribution which included every package in one giant tarball. If an end-user only really wanted a small set of packages they were forced to install everything *and then some*. AstroConda is a *if the shoe fits wear it* distribution of packages. If an end-user needs ``HSTCAL``, for example, they can install ``HSTCAL`` and omit much of the rest of HST's software suite.

A *major difference* most people will appreciate is the sheer lack of shell scripts. Ureka's environment was controlled by
several dozen independent scripts. What makes AstroConda different? For one, it is not controlled by user-executed scripts.
Changes to the environment are applied by special (read: embedded) scripts that are executed automatically by ``source activate``,
and the environment variables are unset with every ``source deactivate``. This allows you to switch between several different
environments rapidly without needing to keep track of what is defined in the environment.
A *major difference* most people will appreciate is the sheer lack of shell scripts. Ureka's environment was controlled by several dozen independent scripts. What makes AstroConda different? For one, it is not controlled by user-executed scripts. Changes to the environment are applied by special (read: embedded) scripts that are executed automatically by ``source activate``, and the environment variables are unset with every ``source deactivate``. This allows you to switch between several different environments rapidly without needing to keep track of what is
defined in the environment.

How often are updates released?
===============================

Updates to (STScI) software will be released as bugs are identified and squashed. The ``stsci-*`` metapackages, for example, provide
"releases" (i.e. a set of software used by our internal pipelines). After installing a release it is then possible to upgrade to the latest
out-of-band packages by simply running:
Updates to (STScI) software will be released as bugs are identified and squashed. The ``stsci-*`` metapackages, for example, provide "releases" (i.e. a set of software used by our internal pipelines). After installing a release it is then possible to upgrade to the latest out-of-band packages by simply running:

``conda update -n astroconda --all``

Non-STScI software will be upgraded on an as-needed basis. See the `Contibuting Guide <contributing.html>`_ to learn more about asking
for updates to existing packages.
Non-STScI software will be upgraded on an as-needed basis. See the `Contibuting Guide <contributing.html>`_ to learn more about asking for updates to existing packages.

What happened to SSBX?
======================

SSBX was a weekly release of STScI's software suite regardless of the stability of the codebase. This release was often times
broken and caused issues for external users. SSBX has been rolled into AstroConda as out-of-band package updates. This offers
a much better user experience, because as bugs are fixed, people will be able to upgrade without waiting until the following week.
SSBX was a weekly release of STScI's software suite regardless of the stability of the codebase. This release was often times broken and caused issues for external users. SSBX has been rolled into AstroConda as out-of-band package updates. This offers a much better user experience, because as bugs are fixed, people will be able to upgrade without waiting until the following week.

What happened to SSBDEV?
========================

SSBDEV was a nightly snapshot release of STScI's software suite. This release was often times broken and caused issues for
external users. Nightly snapshots are ***no longer available*** for use by the public. Updates to AstroConda will be made
directly as existing software is improved and/or new software is released.
SSBDEV was a nightly snapshot release of STScI's software suite. This release was often times broken and caused issues for external users. Nightly snapshots are ***no longer available*** for use by the public. Updates to AstroConda will be made directly as existing software is improved and/or new software is released.

Why isn't IRAF installed by default?
====================================
Expand All @@ -110,18 +94,15 @@ If you are already using AstroConda under a Python 2 environment, you may simply
Why is IRAF/PyRAF less functional under Python 3?
=================================================

The Python code in ``stsdas``, for example, is targeted specifically for Python 2.7 and earlier. If the demand for Python 3
support under IRAF is great enough we may be able to pull our resources to accommodate the community. It is recommended to install
IRAF into its own environment under Python 2.7:
The Python code in ``stsdas``, for example, is targeted specifically for Python 2.7 and earlier. If the demand for Python 3 support under IRAF is great enough we may be able to pull our resources to accommodate the community. It is recommended to install IRAF into its
own environment under Python 2.7:

``conda create -n iraf27 python=2.7 iraf pyraf stsci && source activate iraf27``

Why is IRAF 32-bit instead of 64-bit?
=====================================

Many of the IRAF tasks that we include with AstroConda are so old that they cannot be compiled as 64-bit executables
without significant changes to the source code. Because of this restriction, we always build IRAF as a 32-bit program, even
for our 64-bit distributions.
Many of the IRAF tasks that we include with AstroConda are so old that they cannot be compiled as 64-bit executables without significant changes to the source code. Because of this restriction, we always build IRAF as a 32-bit program, even for our 64-bit distributions.

In Linux, how do I install IRAF's 32-bit dependencies?
------------------------------------------------------
Expand All @@ -147,7 +128,6 @@ RHEL/CentOS >=6, Fedora >=14
Will AstroConda interfere with other scientific distributions (e.g. SciSoft)?
=============================================================================

**Probably**, however unlike Ureka, we do not impose any restrictions on your environment or issue compatibility warnings at run-time.
It is your responsibility to maintain a functional shell environment so [insert scientific distribution here] does not conflict with your Anaconda
installation.
**Probably**, however unlike Ureka, we do not impose any restrictions on your environment or issue compatibility
warnings at run-time. It is your responsibility to maintain a functional shell environment so [insert scientific distribution here] does not conflict with your Anaconda installation.

10 changes: 4 additions & 6 deletions source/index.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
Welcome to AstroConda's documentation!
======================================

AstroConda is a free software repository maintained by the `Space Telescope Science Institute <http://www.stsci.edu/>`_ (STScI)
in Baltimore, Maryland. This repository provides tools and utilities commonly used by the astronomical community.
AstroConda is a free software repository maintained by the `Space Telescope Science Institute <http://www.stsci.edu/>`_ (STScI) in Baltimore, Maryland. This repository provides tools and utilities commonly used by the astronomical community.

The components provided through the `astroconda <http://ssb.stsci.edu/astroconda>`_ channel on `ssb.stsci.edu <http://ssb.stsci.edu>`_
include most of the tools the user needs to work with Hubble Space Telescope (HST) data and data from other telescopes in
a single Anaconda Python environment. Each of the components contains sets of packages which have also been built and tested
to ensure that they work with each other in the same environment.
The components provided through the `astroconda <http://ssb.stsci.edu/astroconda>`_ channel on `ssb.stsci.edu <http://ssb.stsci.edu>`_ include most of the tools the user needs to work with Hubble Space Telescope (HST) data and data from other telescopes in a single Anaconda Python environment. Each of the components contains sets of packages which have also been built and tested to ensure that they work with each
other in the same environment.

To receive AstroConda announcements, or to engage in general discussion, feel free to subscribe to our `mailing list <https://groups.google.com/forum/#!forum/astroconda>`_.


.. toctree::
:maxdepth: 2
:titlesonly:
Expand Down

0 comments on commit f2806db

Please sign in to comment.