planetaryimage


Nameplanetaryimage JSON
Version 0.5.0 PyPI version JSON
download
home_pagehttps://github.com/planetarypy/planetaryimage
SummaryPlanetary image parser supporting
upload_time2016-04-14 01:26:42
maintainerNone
docs_urlNone
authorPlanetaryPy Developers
requires_pythonNone
licenseBSD
keywords planetaryimage
VCS
bugtrack_url
requirements None wheel pep8 flake8 pytest tox sphinx numpydoc matplotlib planetary_test_data
Travis-CI
coveralls test coverage No coveralls.
            ======================================================
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.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/planetarypy/planetaryimage",
    "name": "planetaryimage",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "planetaryimage",
    "author": "PlanetaryPy Developers",
    "author_email": "contact@planetarypy.com",
    "download_url": "https://files.pythonhosted.org/packages/b2/38/eeb0cd2d1f5fa225ed700d7de2d67111cf449f2a32f0a26740186413fc15/planetaryimage-0.5.0.tar.gz",
    "platform": "UNKNOWN",
    "description": "======================================================\nplanetaryimage - Open PDS and Isis CubeFiles in Python\n======================================================\n\n.. image:: https://travis-ci.org/planetarypy/planetaryimage.svg?branch=master\n    :target: https://travis-ci.org/planetarypy/planetaryimage\n\n.. image:: https://img.shields.io/pypi/v/planetaryimage.svg\n        :target: https://pypi.python.org/pypi/planetaryimage\n\n**NOTE** This is Alpha quality software that is being actively developed, use\nat your own risk.\n\nPlanetary image parser\n\n* Free software: BSD license\n* Documentation: https://planetaryimage.readthedocs.org.\n\nFeatures\n--------\n\n* Reads in PDS Images as NumPy arrays.\n\n  - Supports GZIP and BZ2 compressed PDS Images.\n  - Supports writing out PDS3 images.\n\n* Reads in Isis Cube Files as NumPy arrays.\n\nCheck out a few simple examples of\n`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>`_.\n\nQuickstart\n----------\n\nThe example below will walk you through setting up a Python virtual\nenvironment and installing the necessary software as well as a few handy\nextras.  It then downloads a sample Pancam PDS image, opens and displays that\nimage in your web browser in an\n`IPython Notebook <http://ipython.org/notebook.html>`_.  The example assumes\nyou have ``Python``, ``virtualenv``, and ``pip`` installed on your system.  If you\ndon't, don't know what this means or aren't thrilled by the opportunity to\nlearn what this means, this software may be a little too immature for you to\nuse at this point.\n\nCreate and activate a virtual environment::\n\n  virtualenv venv\n  source venv/bin/activate\n\nUpgrade pip, then pip install the package and IPython notebook and matplotlib\nto help display the image::\n\n  pip install -U pip\n  pip install planetaryimage matplotlib ipython[notebook]\n\nThis quick example will show how to open and display a Pancam PDS image using\nthis module.  First, grab a sample image::\n\n  wget http://pds-imaging.jpl.nasa.gov/data/mer/opportunity/mer1po_0xxx/data/sol2840/edr/1p380322615effbr43p2443l1m1.img\n\nNow run python in an IPython Notebook (a browser window should pop up after\nentering the following command)::\n\n  $ ipython notebook\n\nCreate a new notebook in your web browser and then paste the following code\ninto a cell and execute it by pressing Shift+ENTER.  This will load and display\nthe image::\n\n  %matplotlib inline\n  import matplotlib.pyplot as plt\n  from planetaryimage import PDS3Image\n  image = PDS3Image.open('1p380322615effbr43p2443l1m1.img')\n  plt.imshow(image.image, cmap='gray')\n\nSee `Usage <https://planetaryimage.readthedocs.org/en/latest/usage.html>`_ for\nfull documentation on how to use planetaryiamge.\n\n\n\n\nHistory\n-------\n\n0.5.0 (2016-04-13)\n---------------------\n\n* Added ability to generate PDS3Image objects from NumPy arrays.\n\n\n0.4.1 (2016-03-26)\n---------------------\n\n* Fixes to saving PDS3 images files after modification of the data.\n\n\n0.4.0 (2016-03-05)\n---------------------\n\n* Added basic support for saving PDS3 images.\n\n\n0.3.0 (2015-09-29)\n---------------------\n\n* Added support for opening PDS images that are gzip or bz2 compressed.\n\n\n0.2.0 (2015-06-17)\n---------------------\n\n* Improved support for float type PDS3 image types.  Many types still not\n  supported.\n\n\n0.1.0 (2015-06-03)\n---------------------\n\n* First release on PyPI.  Basic PDS and Isis Cube File parsing works.",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Planetary image parser supporting",
    "version": "0.5.0",
    "split_keywords": [
        "planetaryimage"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "092e0ef2bb13ab760a8122a411b28595",
                "sha256": "e222f42e53bb37b4e4b5a01718c32cde71aebfb47949ba621714a5af13c2364e"
            },
            "downloads": -1,
            "filename": "planetaryimage-0.5.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "092e0ef2bb13ab760a8122a411b28595",
            "packagetype": "bdist_wheel",
            "python_version": "2.7",
            "requires_python": null,
            "size": 13540,
            "upload_time": "2016-04-14T01:26:47",
            "upload_time_iso_8601": "2016-04-14T01:26:47.863313Z",
            "url": "https://files.pythonhosted.org/packages/41/b8/1706e311a345591870f566d734d79d83d483c411a7425b65f53d8d6c6590/planetaryimage-0.5.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "bec83672809801cea54a8e85209755de",
                "sha256": "6b6af0d83147fe3fc4550ea753557010f01dd1bf905e060f7b942b3f16b38def"
            },
            "downloads": -1,
            "filename": "planetaryimage-0.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "bec83672809801cea54a8e85209755de",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 89809,
            "upload_time": "2016-04-14T01:26:42",
            "upload_time_iso_8601": "2016-04-14T01:26:42.001907Z",
            "url": "https://files.pythonhosted.org/packages/b2/38/eeb0cd2d1f5fa225ed700d7de2d67111cf449f2a32f0a26740186413fc15/planetaryimage-0.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2016-04-14 01:26:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "planetarypy",
    "github_project": "planetaryimage",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": null,
            "specs": []
        },
        {
            "name": "wheel",
            "specs": [
                [
                    ">=",
                    "0.23.0"
                ]
            ]
        },
        {
            "name": "pep8",
            "specs": [
                [
                    "==",
                    "1.5.7"
                ]
            ]
        },
        {
            "name": "flake8",
            "specs": [
                [
                    "==",
                    "2.4.1"
                ]
            ]
        },
        {
            "name": "pytest",
            "specs": []
        },
        {
            "name": "tox",
            "specs": []
        },
        {
            "name": "sphinx",
            "specs": []
        },
        {
            "name": "numpydoc",
            "specs": []
        },
        {
            "name": "matplotlib",
            "specs": []
        },
        {
            "name": "planetary_test_data",
            "specs": [
                [
                    ">=",
                    "0.3.0"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "planetaryimage"
}
        
Elapsed time: 0.03027s