Merge pull request #148 from crawfordsm/docupdates

Docupdates

README.rst

@@ -7,6 +7,14 @@ ccdproc
 .. image:: https://coveralls.io/repos/astropy/ccdproc/badge.png
   :target: https://coveralls.io/r/astropy/ccdproc
 
+Ccdproc is is an affiliated package for
+the AstroPy package for basic data reductions of CCD images.   The ccdproc 
+package provides many of the necessary tools for processing of ccd images built
+on a framework to provide error propogation and bad pixel tracking throughout
+the reduction process.   
+
+Ccdproc can currently be installed via pip, anaconda, or from the source code.  For installation instructions, see the online documentation or docs/install.rst in this source distribution.
+
 This package is a work in progress...feel free to help out by picking an issue and working on it!
 
 Documentation is at `ccdproc.readthedocs.org <http://ccdproc.readthedocs.org/en/latest/>`_

docs/index.rst

@@ -1,8 +1,14 @@
+
+Welcome to the ccdproc documentation!   Ccdproc is is an affiliated package for
+the AstroPy package for basic data reductions of CCD images.   The ccdproc 
+package provides many of the necessary tools for processing of ccd images built
+on a framework to provide error propogation and bad pixel tracking throughout
+the reduction process.   
+
 Documentation
 =============
 
-This is an affiliated package for the AstroPy package. The documentation for
-this package is here:
+The documentation for this package is here:
 
 .. toctree::
   :maxdepth: 2

docs/install.rst

@@ -0,0 +1,67 @@
+************
+Installation
+************
+
+Requirements
+============
+
+Ccdproc has the following requirements:
+- astropy v0.4
+- numpy
+- scipy
+
+Installing ccdproc
+==================
+
+Using pip
+-------------
+
+To install ccdproc with `pip <http://www.pip-installer.org/en/latest/>`_, simply run::
+
+    pip install --no-deps ccdproc
+
+.. note::
+
+    The ``--no-deps`` flag is optional, but highly recommended if you already
+    have Numpy installed, since otherwise pip will sometimes try to "help" you
+    by upgrading your Numpy installation, which may not always be desired.
+
+Building from source
+====================
+
+Obtaining the source packages
+-----------------------------
+
+Source packages
+^^^^^^^^^^^^^^^
+
+The latest stable source package for ccdproc can be `downloaded here
+<https://pypi.python.org/pypi/ccdproc>`_.
+
+Development repository
+^^^^^^^^^^^^^^^^^^^^^^
+
+The latest development version of ccdproc can be cloned from github
+using this command::
+
+   git clone git://github.com/astropy/ccdproc.git
+
+Building and Installing
+-----------------------
+
+To build ccdproc (from the root of the source tree)::
+
+    python setup.py build
+
+To install ccdproc (from the root of the source tree)::
+
+    python setup.py install
+
+Testing a source code build of ccdproc
+--------------------------------------
+
+The easiest way to test that your ccdproc built correctly (without
+installing ccdproc) is to run this from the root of the source tree::
+
+    python setup.py test
+

docs/rtd-pip-requirements

@@ -1,4 +1,4 @@
 numpy>=1.7
 scipy
 numpydoc
-astropy>=0.3
+astropy>=0.4