Skip to content

michaelaye/planetarypy_orig

Repository files navigation

planetarypy

Collection of planetary science tools.

Build Status Coverage Status Documentation Status Join the chat at https://gitter.im/michaelaye/planetpy

Cite me

If you use this software, please consider citing it:

DOI

Vision

  • Similar to astropy to collect useful planetary science modules.
  • Managing easily accessible constants
  • Hooking into existing SPICE and osgeo/gdal installs for some utilities:
  • SPICER: A SPICE utility class that makes SPICE-life easier for planetary surface calculations related to irradiation (available, but needs clean-up)
  • GeoRaster: A class that uses GDAL but again adds user-friendly interfaces to coordinate transformtion, sub-solar point direction marking, and combination of different data-sets into one (e.g. laser altimeter on top of image data etc.) (available, but needs clean-up)
  • Areas I want to avoid overlapping with as much as possible:
  • GDAL's vast capability of reading geo-referenced images. Any functionality we are missing should be integrated as much as possible into GDAL, for example I think several PDS formats are still failing with the PDS reader of GDAL. Maybe, we could store virtual GDAL formats here, if requested.
  • scikit-image for image analysis routines.

Install

If you want to develop for planetarypy I recommend installing it like this:

pip install -e .

Note the . at the end. This will create a path link into the github directory, and you can avoid adding setting up a PYTHONPATH which can create a lot of trouble. All new developments will become automatically active, i.e. importable without another install. In addition to that I highly recommend these lines for the IPython notebook setup:

%load_ext autoreload
%autoreload 2

This will even autoMAGICALLY make your notebook session aware of any new developments you have added to planetarypy.

If you just want to use planetarypy and don't want to be surprised about any changes that might be added into your repository clone after doing a git pull then install in the standard way:

pip install .

Note that the install via pip is now preferred compared to python setup.py install due to cleaner removal supported by pip. Note also that this way you will have to execute another python setup.py install each time you git-pull in updates from github.