Metadata-Version: 1.1
Name: planetaryimage
Version: 0.5.0
Summary: Planetary image parser supporting
Home-page: https://github.com/planetarypy/planetaryimage
Author: PlanetaryPy Developers
Author-email: contact@planetarypy.com
License: BSD
Description: ======================================================
        planetaryimage - Open PDS and Isis CubeFiles in Python
        ======================================================
        
        .. image:: https://travis-ci.org/planetarypy/planetaryimage.svg?branch=master
            :target: https://travis-ci.org/planetarypy/planetaryimage
        
        .. image:: https://img.shields.io/pypi/v/planetaryimage.svg
                :target: https://pypi.python.org/pypi/planetaryimage
        
        **NOTE** This is Alpha quality software that is being actively developed, use
        at your own risk.
        
        Planetary image parser
        
        * Free software: BSD license
        * Documentation: https://planetaryimage.readthedocs.org.
        
        Features
        --------
        
        * Reads in PDS Images as NumPy arrays.
        
          - Supports GZIP and BZ2 compressed PDS Images.
          - Supports writing out PDS3 images.
        
        * Reads in Isis Cube Files as NumPy arrays.
        
        Check out a few simple examples of
        `opening and viewing PDS and Isis CubeFiles in an IPython notebook <http://nbviewer.ipython.org/urls/gist.githubusercontent.com/godber/dfb5d012fda603619ab9/raw/b1db599f53a5c468075ff854e9056698bd005cc7/gistfile1.json>`_.
        
        Quickstart
        ----------
        
        The example below will walk you through setting up a Python virtual
        environment and installing the necessary software as well as a few handy
        extras.  It then downloads a sample Pancam PDS image, opens and displays that
        image in your web browser in an
        `IPython Notebook <http://ipython.org/notebook.html>`_.  The example assumes
        you have ``Python``, ``virtualenv``, and ``pip`` installed on your system.  If you
        don't, don't know what this means or aren't thrilled by the opportunity to
        learn what this means, this software may be a little too immature for you to
        use at this point.
        
        Create and activate a virtual environment::
        
          virtualenv venv
          source venv/bin/activate
        
        Upgrade pip, then pip install the package and IPython notebook and matplotlib
        to help display the image::
        
          pip install -U pip
          pip install planetaryimage matplotlib ipython[notebook]
        
        This quick example will show how to open and display a Pancam PDS image using
        this module.  First, grab a sample image::
        
          wget http://pds-imaging.jpl.nasa.gov/data/mer/opportunity/mer1po_0xxx/data/sol2840/edr/1p380322615effbr43p2443l1m1.img
        
        Now run python in an IPython Notebook (a browser window should pop up after
        entering the following command)::
        
          $ ipython notebook
        
        Create a new notebook in your web browser and then paste the following code
        into a cell and execute it by pressing Shift+ENTER.  This will load and display
        the image::
        
          %matplotlib inline
          import matplotlib.pyplot as plt
          from planetaryimage import PDS3Image
          image = PDS3Image.open('1p380322615effbr43p2443l1m1.img')
          plt.imshow(image.image, cmap='gray')
        
        See `Usage <https://planetaryimage.readthedocs.org/en/latest/usage.html>`_ for
        full documentation on how to use planetaryiamge.
        
        
        
        
        History
        -------
        
        0.5.0 (2016-04-13)
        ---------------------
        
        * Added ability to generate PDS3Image objects from NumPy arrays.
        
        
        0.4.1 (2016-03-26)
        ---------------------
        
        * Fixes to saving PDS3 images files after modification of the data.
        
        
        0.4.0 (2016-03-05)
        ---------------------
        
        * Added basic support for saving PDS3 images.
        
        
        0.3.0 (2015-09-29)
        ---------------------
        
        * Added support for opening PDS images that are gzip or bz2 compressed.
        
        
        0.2.0 (2015-06-17)
        ---------------------
        
        * Improved support for float type PDS3 image types.  Many types still not
          supported.
        
        
        0.1.0 (2015-06-03)
        ---------------------
        
        * First release on PyPI.  Basic PDS and Isis Cube File parsing works.
        
Keywords: planetaryimage
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
