-
Notifications
You must be signed in to change notification settings - Fork 20
Requirements
Austin Godber edited this page Aug 5, 2015
·
6 revisions
- Python 2/3 compliant
- Simple binary read / GDAL reader via introspection
- Numpy out
- Pep8-ish
- Sphinx and NumpyDoc
- Travis-CI (2.7+)
- Tox testing (build out test files, Austin students, ISIS tests, 2.7+)
- minimize external dep.
- BSD
- Model after AstroPy
- separate module for GDAL, IDL
questions:
- writer: from ISIS3 or ...? Does PDS have a writer
- support for Anaconda (best for now though)
- GDAL API or RasterIO
- compressed PDS not supported
- Austin's GDAL reader... -Viewer? Ginga, Austin's Gui, TuiView
Why GDAL (we know painful dep.): supported in Anaconda compression support transparency color options pyramids (support for any image) Need to add more metadata reads...?
- Tests must be implemented/executed with PyTest
- Docstrings must be in numpydoc format
- The packages
sphinx
andnumpydoc
should be development dependencies (in cookiecutter template!). - Validity of all doctests (in code or docs) must be validated by continuous integration.
Currently, the planetaryimage package adheres to these requirements. Look at the numpydoc
docstrings, the docs, the tests, the Makefile
, tox.ini
and .travis.yml
for examples.