Added a quick start guide to the docs & restructured Pythong docs (#378)

* Added loads docs

* Added other base driver mix-ins

* Simple quick start guide

* minor clean up

* Added quick start and cleaned up

* Combined mix-in files

* Fixed label data name

* Restructured Python docs

* Added Python rotation docs

* PR review updates

* Updated label_data description

ale/base/data_naif.py

@@ -9,6 +9,10 @@ from ale.rotation import TimeDependentRotation
 from ale import util
 
 class NaifSpice():
+    """
+    Mix-in for reading data from NAIF SPICE Kernels.
+    """
+
     def __enter__(self):
         """
         Called when the context is created. This is used
@@ -29,6 +33,30 @@ class NaifSpice():
 
     @property
     def kernels(self):
+        """
+        Get the NAIF SPICE Kernels to furnish
+
+        There are two ways to specify which kernels a driver will use:
+
+        1. Passing the 'kernels' property into load(s) or at instantiation.
+           This can be either a straight iterable or a dictionary that specifies
+           the kernels in ISIS style ('TargetPosition', 'InstrumentPosition', etc).
+        2. Set the ALESPICEROOT environment variable. This variable should be
+           the path to a directory that contains directories whose naming
+           convention matches the PDS Kernel Archives format,
+           `shortMissionName-versionInfo`. The directory corresponding to the
+           driver's mission will be searched for the approriate meta kernel to
+           load.
+
+        See Also
+        --------
+        ale.util.get_kernels_from_isis_pvl : Function used to parse ISIS style dict
+        ale.util.get_metakernels : Function that searches ALESPICEROOT for meta kernels
+        ale.util.generate_kernels_from_cube : Helper function to get an ISIS style dict
+                                              from an ISIS cube that has been through
+                                              spiceinit
+
+        """
         if not hasattr(self, '_kernels'):
             if 'kernels' in self._props.keys():
                 try:

ale/base/label_isis.py

 import pvl
 
 class IsisLabel():
+    """
+    Mix-in for parsing ISIS Cube labels.
+    """
 
     @property
     def label(self):

ale/base/label_pds3.py

 import pvl
 
 class Pds3Label():
+    """
+    Mix-in for parsing PDS3 PVL labels.
+    """
 
     @property
     def label(self):

ale/base/type_distortion.py

 class RadialDistortion():
+    """
+    Mix-in for sensors that use a radial distortion model.
+    """
+
     @property
     def usgscsm_distortion_model(self):
         """
@@ -18,6 +22,10 @@ class RadialDistortion():
 
 
 class NoDistortion():
+    """
+    Mix-in for sensors and data sets that do not have a distortion model.
+    """
+
     @property
     def usgscsm_distortion_model(self):
         """

ale/base/type_sensor.py

 import numpy as np
 
 class LineScanner():
+    """
+    Mix-in for line scan sensors.
+    """
 
     @property
     def name_model(self):
@@ -70,6 +73,10 @@ class LineScanner():
         return self.ephemeris_start_time + (self.image_lines * self.exposure_duration)
 
 class Framer():
+    """
+    Mix-in for framing sensors.
+    """
+
     @property
     def name_model(self):
         """
@@ -114,6 +121,10 @@ class Framer():
         return self.ephemeris_start_time + self.exposure_duration
 
 class Radar():
+    """
+    Mix-in for synthetic aperture radar sensors.
+    """
+
     @property
     def name_model(self):
         """

ale/drivers/__init__.py

@@ -55,7 +55,12 @@ class AleJsonEncoder(json.JSONEncoder):
 
 def load(label, props={}, formatter='ale', verbose=False):
     """
-    Attempt to load a given label from all possible drivers
+    Attempt to load a given label from all possible drivers.
+
+    This function opens up the label file and attempts to produce an ISD in the
+    format specified using the supplied properties. Drivers are tried sequentially
+    until an ISD is successfully created. Drivers that use external ephemeris
+    data are tested before drivers that use attached epehemeris data.
 
     Parameters
     ----------
@@ -64,13 +69,23 @@ def load(label, props={}, formatter='ale', verbose=False):
 
     props : dict
             A dictionary of optional keywords/parameters for use in driver
-            loading
+            loading. Each driver specifies its own set of properties to use.
+            For example, Drivers that use the NaifSpice mix-in use the 'kernels'
+            property to specify an explicit set of kernels and load order.
 
-    formatter : str
-                Formatted output to expect from the driver
+    formatter : {'ale', 'isis', 'usgscsm'}
+                Output format for the ISD. As of 0.8.0, it is recommended that
+                the `ale` formatter is used. The `isis` and `usgscsm` formatters
+                are retrained for backwards compatability.
 
     verbose : bool
-              If True, displays error messages from driver loading
+              If True, displays debug output specifying which drivers were
+              attempted and why they failed.
+
+    Returns
+    -------
+    dict
+         The ISD as a dictionary
     """
     if isinstance(formatter, str):
         formatter = __formatters__[formatter]
@@ -99,5 +114,19 @@ def load(label, props={}, formatter='ale', verbose=False):
     raise Exception('No Such Driver for Label')
 
 def loads(label, props='', formatter='ale', verbose=False):
+    """
+    Attempt to load a given label from all possible drivers.
+
+    This function is the same as load, except it returns a JSON formatted string.
+
+    Returns
+    -------
+    str
+        The ISD as a JSON formatted string
+
+    See Also
+    --------
+    load
+    """
     res = load(label, props, formatter, verbose=verbose)
     return json.dumps(res, cls=AleJsonEncoder)

docs/source/index.rst

@@ -9,3 +9,4 @@ Ephemeris Abstraction Library
    :maxdepth: 3
 
    library/index
+   tutorials/index

docs/source/library/python/concrete_drivers/index.rst

+:mod:`concrete-drivers` --- Concrete Sensor Driver
+==================================================
+
+The classes in these modules are the concrete drivers that are composed from
+the base :py:class:`ale.base.base.Driver` class and various mix-ins classes.
+
+.. toctree::
+
+  co_driver
+  dawn_driver
+  hayabusa2_driver
+  isis_ideal_driver
+  juno_driver
+  lro_driver
+  mess_driver
+  mex_driver
+  mro_driver
+  nh_driver
+  ody_driver
+  selene_driver
+  tgo_driver
+  viking_driver
+  voyager_driver