From f0b19ccff65ad1a2adbf0c43e84d4a5adeda3d87 Mon Sep 17 00:00:00 2001 From: Joseph Hunkeler Date: Fri, 18 Mar 2016 09:39:53 -0400 Subject: Initital commit --- source/conf.py | 286 ++++++++++++++++++++++++++++++++++++++++++++++++ source/contributing.rst | 4 + source/faq.rst | 30 +++++ source/index.rst | 28 +++++ source/installation.rst | 60 ++++++++++ source/resources.rst | 5 + source/updating.rst | 68 ++++++++++++ source/whatis.rst | 5 + 8 files changed, 486 insertions(+) create mode 100644 source/conf.py create mode 100644 source/contributing.rst create mode 100644 source/faq.rst create mode 100644 source/index.rst create mode 100644 source/installation.rst create mode 100644 source/resources.rst create mode 100644 source/updating.rst create mode 100644 source/whatis.rst (limited to 'source') diff --git a/source/conf.py b/source/conf.py new file mode 100644 index 0000000..5f1283e --- /dev/null +++ b/source/conf.py @@ -0,0 +1,286 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# AstroConda documentation build configuration file, created by +# sphinx-quickstart on Wed Mar 16 23:13:03 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.coverage', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'AstroConda' +copyright = '2016, Space Telescope Science Institute' +author = 'Space Telescope Science Institute' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.0.1' +# The full version, including alpha/beta/rc tags. +release = '0.0.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'AstroCondadoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'AstroConda.tex', 'AstroConda Documentation', + 'Space Telescope Science Institute', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'astroconda', 'AstroConda Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'AstroConda', 'AstroConda Documentation', + author, 'AstroConda', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/source/contributing.rst b/source/contributing.rst new file mode 100644 index 0000000..b73725e --- /dev/null +++ b/source/contributing.rst @@ -0,0 +1,4 @@ +****************** +Contributing Guide +****************** + diff --git a/source/faq.rst b/source/faq.rst new file mode 100644 index 0000000..075cd8e --- /dev/null +++ b/source/faq.rst @@ -0,0 +1,30 @@ +###### +F.A.Q. +###### + + +How does AstroConda differ from Ureka? +====================================== + +TODO + +How often are updates released? +=============================== + +TODO + +Why isn't IRAF installed by default? +==================================== + +TODO + +Why can't I install IRAF in a Python 3 environment? +=================================================== + +TODO + +Will AstroConda interfere with scientific software distributions (e.g. SciSoft)? +================================================================================ + +TODO + diff --git a/source/index.rst b/source/index.rst new file mode 100644 index 0000000..9874cdd --- /dev/null +++ b/source/index.rst @@ -0,0 +1,28 @@ +.. AstroConda documentation master file, created by + sphinx-quickstart on Wed Mar 16 23:13:03 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to AstroConda's documentation! +====================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + whatis + installation + updating + contributing + faq + resources + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/source/installation.rst b/source/installation.rst new file mode 100644 index 0000000..39260aa --- /dev/null +++ b/source/installation.rst @@ -0,0 +1,60 @@ +############ +Installation +############ + + +Obtain Anaconda +================ + +.. note:: AstroConda packages are 64-bit only. We may consider building 32-bit binaries for Linux if there is a demand for it. + +Grab a copy of the `Anaconda3 `_ distribution from Continuum, Inc. + +Be sure to select the installer appropriate for your operating system and architecture. Installation instructions are +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 `_ repositories to this file may affect the stability of AstroConda's run-time +environment. + +Use a plain-text editor to append the following to $HOME/.condarc: + +.. code-block:: sh + + channels: + - astroconda + - defaults + + +Install AstroConda +================== + +Now that conda is configured to pull from our repository, you may now go ahead and install the ``astroconda`` +meta-package. + +.. code-block:: sh + + $ conda create -n astroconda astroconda + $ 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 `_ and +install a custom mix of packages *tailored to your needs*. + +.. code-block:: sh + + $ conda create -n astroconda [package [package ...]] + $ source activate astroconda + + + diff --git a/source/resources.rst b/source/resources.rst new file mode 100644 index 0000000..844ff6e --- /dev/null +++ b/source/resources.rst @@ -0,0 +1,5 @@ +********* +Resources +********* + +TODO \ No newline at end of file diff --git a/source/updating.rst b/source/updating.rst new file mode 100644 index 0000000..6d7b9ec --- /dev/null +++ b/source/updating.rst @@ -0,0 +1,68 @@ +***************************** +Keeping AstroConda "Like New" +***************************** + +Anaconda's package manager, Conda, will not automatically update unless a newer version of a package is detected during +a routine package installation. Suffice to say, unless you keep your packages up to date with ``conda update``, the +packages installed in your Anaconda distribution will remain relatively static. + +Updating AstroConda +=================== + +The update procedure for AstroConda is relatively straight foward. + +.. code-block:: sh + + # Will update all packages + $ conda update --all + + # Will update packages if a new public release is present + $ conda update astroconda + +(`ref `__) + + +Downgrading Packages +==================== + +Did a recent update break your code? Don't wait around for a bugfix... Keep working. For example, if a bug is introduced +into ``stsci.tool``, you can easily downgrade it to a known-good version: + +.. code-block:: sh + + $ conda search stsci.tools + . 3.4.0.git py35_6 astroconda + * 3.4.1.git py35_0 astroconda + +The ``*`` denotes the current version installed locally. + +Now the only thing left do is tell Conda to install the previous release of the package: + +.. code-block:: sh + + $ conda install stsci.tools=3.4.0 + +At this point you should be back in business. + +(`ref `__) + + +Pinning Packages +================ + +.. caution:: Pinning packages has the potential to break Conda. Only pin packages as a last resort. + +Let's take the previous example one step further... Imagine ``stsci.tools`` is broken, and the hotfix release of ``3.4.2`` +only partially solved the original issue. Now what? You still need to receive updates to other packages, but +``stsci.tools`` keeps trying to update back to ``3.4.2`` every time you touch ``conda update``. + + +.. code-block:: sh + + $ echo "stsci.tools <=3.4.0" > ${CONDA_ENV_PATH}/conda-meta/pinned + +From now on, future calls to ``conda update`` will omit ``stsci.tools`` while performing dependency resolution. However, +a clear side-effect of this will also be losing the ability to update packages that depend strictly on version ``3.4.2``. +Although this is not a permanent solution it can prove useful in a bad situation. + +(`ref `__) diff --git a/source/whatis.rst b/source/whatis.rst new file mode 100644 index 0000000..db76b57 --- /dev/null +++ b/source/whatis.rst @@ -0,0 +1,5 @@ +******************* +What is AstroConda? +******************* + +TODO \ No newline at end of file -- cgit