Merge pull request #19 from andrewpaulreeves/master

Updates for 0.2

aotools/__init__.py

@@ -1,5 +1,6 @@
 from . import astronomy, functions, image_processing, wfs, turbulence
 
+from .astronomy import *
 from .functions import *
 from .fouriertransform import *
 from .interpolation import *

aotools/astronomy/__init__.py

@@ -1 +1 @@
-from .astronomy import *
+from ._astronomy import *

aotools/turbulence/opticalpropagation.py → aotools/opticalpropagation.py

@@ -1,12 +1,12 @@
 '''
-A library of optical propagation methods.
+A library of useful optical propagation methods.
 
 Many extracted from the book by Schmidt, 2010: Numerical Methods
 of optical proagation
 '''
 
 import numpy
-from .. import fouriertransform
+from . import fouriertransform
 
 def angularSpectrum(inputComplexAmp, wvl, inputSpacing, outputSpacing, z):
     """

aotools/turbulence/__init__.py

@@ -1,6 +1,5 @@
 from .phasescreen import *
 from .infinitephasescreen import *
 from .temporal_ps import *
-from .opticalpropagation import *
 from .slopecovariance import *
 from .turb import *

aotools/turbulence/infinitephasescreen.py

@@ -135,7 +135,7 @@ def makeAMatrix(self):
             cf = linalg.cho_factor(self.cov_mat_zz)
             inv_cov_zz = linalg.cho_solve(cf, numpy.identity(self.cov_mat_zz.shape[0]))
         except linalg.LinAlgError:
-            inv_cov_zz = linalg.inv(self.cov_mat_zz)
+            raise linalg.LinAlgError("Could not invert Covariance Matrix to for A and B Matrices. Try with a larger pixel scale")
 
         self.A_mat = self.cov_mat_xz.dot(inv_cov_zz)
 

doc/source/index.rst

@@ -18,6 +18,7 @@ Contents:
    fft
    wfs
    zernike
+   opticalpropagation
 
 Indices and tables
 ==================

doc/source/introduction.rst

@@ -1,7 +1,18 @@
-AOtools
-=======
+Introduction
+============
 
 AOtools is an attempt to gather together many common tools, equations and functions for Adaptive Optics.
 The idea is to provide an alternative to the current model, where a new AO researcher must write their own library
 of tools, many of which implement theory and ideas that have been in existance for over 20 years. AOtools will hopefully
-provide a common place to put these tools, which through use and bug fixes, should become reliable and well documented.
+provide a common place to put these tools, which through use and bug fixes, should become reliable and well documented.
+
+Installation
+------------
+AOtools uses mainly standard library functions, and all attempts have been made to avoid adding unneccessary dependencies.
+Currently, the library requires only
+
+- numpy
+- scipy
+- astropy
+- matplotlib
+

doc/source/opticalpropagation.rst

@@ -0,0 +1,7 @@
+Optical Propagation
+===================
+
+.. automodule:: aotools.opticalpropagation
+    :members:
+    :undoc-members:
+    :show-inheritance:

test/testOpticalprop.py

@@ -8,8 +8,8 @@
 import numpy
 
 import logging
-from aotools.turbulence import opticalpropagation, phasescreen
-from aotools import circle
+from aotools.turbulence import phasescreen
+from aotools import circle, opticalpropagation
 
 logging.basicConfig()