Merge pull request #57 from lsst/14.0

Version 14.0 integration branch

conf.py

@@ -23,7 +23,7 @@
 sys.setrecursionlimit(2000)
 
 # master variable for current Stack release
-CURRENT_RELEASE = '13.0'
+CURRENT_RELEASE = '14.0'
 
 # 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

index.rst

@@ -5,30 +5,61 @@ The LSST Science Pipelines
 The LSST Science Pipelines enable optical and near-infrared astronomy in the big data era.
 We are building the Science Pipelines for the `Large Synoptic Survey Telescope (LSST) <http://lsst.org>`_, but our command line task and Python API can be extended for any optical or near-infrared dataset.
 
-- Join us on the `LSST Community forum, community.lsst.org <http://community.lsst.org>`_.
-- Fork our code on GitHub at https://github.com/lsst.
-- Report issues in `JIRA <https://jira.lsstcorp.org/projects/DM/issues/>`_.
-- API documentation is currently published with `Doxygen <http://doxygen.lsst.codes/stack/doxygen/x_masterDoxyDoc/>`_.
-- DM Developer guidance is at https://developer.lsst.io.
-- Learn more about LSST Data Management by visiting http://dm.lsst.org.
-- Help us improve our documentation! This guide is on GitHub at `lsst/pipelines_lsst_io <https://github.com/lsst/pipelines_lsst_io>`_.
+The latest release is |current-release|: :doc:`learn what's new <releases/index>`.
 
-Latest release
-==============
+.. _part-installation:
 
-The latest release is |current-release|: :doc:`learn what's new <releases/index>`.
+Installation
+============
+
+Recommended installation path:
+
+- :doc:`Installing with newinstall.sh <install/newinstall>`
+- :doc:`install/setup`
+- :doc:`install/top-level-packages`
+
+Alternative distributions and installation methods:
+
+- :doc:`install/docker`
+- :doc:`Installing from source with lsstsw <install/lsstsw>`
+- `CernVM FS <https://github.com/airnandez/lsst-cvmfs>`_ (contributed by CC-IN2P3)
+
+Related topics:
+
+- :doc:`install/package-development`
+
+To install the LSST Simulation software, such as MAF, follow the `LSST Simulations documentation <https://confluence.lsstcorp.org/display/SIM/Catalogs+and+MAF>`_.
+
+.. This toctree is hidden to let us curate the section above, but still add the install/ pages to the Sphinx toctree
 
 .. toctree::
    :hidden:
+   :caption: Installation
 
-   releases/index
+   install/index
+
+.. _part-release-details:
 
 .. toctree::
    :maxdepth: 1
-   :caption: Getting Started
-   :name: part-getting-started
+   :caption: Release details
 
-   install/index
-   known-issues
    releases/notes
-   metrics/index
+   known-issues
+   metrics
+
+.. toctree::
+   :hidden:
+
+   releases/index
+
+More info
+=========
+
+- Join us on the `LSST Community forum, community.lsst.org <http://community.lsst.org>`_.
+- Fork our code on GitHub at https://github.com/lsst.
+- Report issues in `JIRA <https://jira.lsstcorp.org/projects/DM/issues/>`_.
+- API documentation is currently published with `Doxygen <http://doxygen.lsst.codes/stack/doxygen/x_masterDoxyDoc/>`_.
+- DM Developer guidance is at https://developer.lsst.io.
+- Learn more about LSST Data Management by visiting http://dm.lsst.org.
+- Contribute to our documentation. This guide is on GitHub at `lsst/pipelines_lsst_io <https://github.com/lsst/pipelines_lsst_io>`_.

install/demo.rst

@@ -1,5 +1,5 @@
 ######################################################
-Testing the Science Pipelines Installation with a Demo
+Testing the Science Pipelines installation with a demo
 ######################################################
 
 This demo will allow you to quickly test your LSST Science Pipelines installation, :doc:`regardless of your installation method <index>`.
@@ -10,15 +10,14 @@ This demo will allow you to quickly test your LSST Science Pipelines installatio
 Remember to first load the LSST Science Pipelines into your shell's environment.
 The method depends on how the Science Pipelines were installed:
 
-- :ref:`Conda <conda-install-activate>`
-- :ref:`newinstall.sh <install-from-source-loadlsst>`
+- :doc:`newinstall.sh <setup>`
 - :ref:`lsstsw <lsstsw-setup>`
 
-2. Download the Demo Project
+2. Download the demo project
 ============================
 
 Choose a directory to run the demo in.
-We'll call this directory :file:`demo_data`.
+For example:
 
 .. code-block:: bash
 
@@ -29,13 +28,13 @@ Then download the demo's data (if you aren't running the current stable release,
 
 .. code-block:: bash
 
-   curl -L https://github.com/lsst/lsst_dm_stack_demo/archive/13.0.tar.gz | tar xvzf -
-   cd lsst_dm_stack_demo-13.0
+   curl -L https://github.com/lsst/lsst_dm_stack_demo/archive/14.0.tar.gz | tar xvzf -
+   cd lsst_dm_stack_demo-14.0
 
 .. note::
 
    The demo's version should match your installed software.
-   If you installed from source (with :doc:`lsstsw <lsstsw>`), clone the demo repository instead of downloading a release:
+   If you installed from source (with :doc:`lsstsw <lsstsw>`) or with a :ref`newer tag <newinstall-other-tags>`, clone the demo repository instead of downloading a release:
 
    .. code-block:: bash
 
@@ -54,7 +53,7 @@ run  camcol field filters
 
 *Filters in parentheses are not processed if run with the* ``--small`` *option, see below*
 
-3. Run the Demo
+3. Run the demo
 ===============
 
 Now setup the processing package and run the demo:
@@ -66,11 +65,12 @@ Now setup the processing package and run the demo:
 
 For each input image the script performs the following operations:
 
-* generate a subset of basic image characterization (e.g., determine photometric zero-point, detect sources, and measures positions, shapes, brightness with a variety of techniques),
-* creates a :command:`./output` subdirectory containing subdirectories of configuration files, processing metadata, calibrated images, FITS tables of detected sources. These "raw" outputs are readable by other parts of the LSST pipeline, and
-* generates a master comparison catalog in the working directory from the band-specific source catalogs in the ``output/sci-results/`` subdirectories.
+- Generates a subset of basic image characterizations (such photometric zero-point estimation, source detection, and measurement).
+- Creates a :file:`./output` directory containing subdirectories of configuration files, processing metadata, calibrated images, and FITS tables of detected sources.
+  These ``raw`` outputs are readable by other parts of the LSST pipeline.
+- Generates a master comparison catalog in the working directory from the band-specific source catalogs in the ``output/sci-results/`` subdirectories.
 
-4. Check the Demo Results
+4. Check the demo results
 =========================
 
 The demo will take a minute or two to execute (depending upon your machine), and will generate a large number of status messages.