general clean-up; docs updated

README.rst

@@ -1,16 +1,83 @@
-A Python Module for Planetary Astronomy
----------------------------------------
+A Python Module for Small-Body Planetary Astronomy
+--------------------------------------------------
 
 .. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
     :target: http://www.astropy.org
     :alt: Powered by Astropy Badge
 
-A Python Module for Asteroid and Comet Research
+
+`sbpy` is a community effort to build a Python package for small-body
+planetary astronomy in the form of an `astropy`_ affiliated package.
 
-More information coming soon!
+The goal is to collect and implement well-tested and well-documented
+code for the scientific study of asteroids and comets, including (but
+not limited to):
 
+* observation planning tools tailored to moving objects,
+* photometry models for resolved and unresolved bodies,
+* wrappers and tools for astrometry and orbit fitting,
+* spectroscopy analysis tools and models for reflected light and emission
+  from gas,
+* cometary gas and dust coma simulation and analysis tools,
+* asteroid thermal models for flux estimation and size/albedo estimation,
+* image enhancement tools for comet comae and PSF subtraction tools,
+* lightcurve and shape analysis tools, and
+* access tools for various databases for orbital and physical data, as well as
+  ephemerides services.
+
+
+This package is under heavy development and currently provides only
+very limited functionality. A funding proposal to support the
+development of `sbpy` is currently pending.
+
+
+
+Documentation
+-------------
+
+Documentation is available `here`_.
+
+
+Contributing
+------------
+
+If you are interested in contributing to `sbpy`, you can do that
+through testing existing code (somewhat easy) or by contributing
+Python code (somewhat hard). We appreciate every contribution and
+acknowledge them by adding you to the list of `sbpy` authors.
+
+Testing
+~~~~~~~
+
+We are looking for people to test our routines. In order to make this
+task worthwhile for you, we only ask you to test routines that are
+stable and which you can already use for your research. We will
+indicate which functions are ready to be tested on this dedicated
+status page (TBD). Keep in mind that there might be issues, so feel free
+to compare the function results with your own results. If you find a
+problem, please issue an issue report on this github page.
+
+Coding
+~~~~~~
+
+If you would like to implement (or modify) some functionality
+yourself, you are welcome to do so. Please check the wiki and the
+documentation if such functionality already exists or is
+planned. Before working on the code, please issue an issue report,
+explaining your contribution and how it would fit into existing `sbpy`
+functionality - please clearly state if existing functionality would
+have to be modified. Once your contribution report has been accepted,
+please fork the `sbpy` repository and work on that code. Once you are
+done, please issue a pull request, linking to your original issue
+report.
+
+
 
 License
 -------
 
 This project is Copyright (c) sbpy team and licensed under the terms of the BSD 3-Clause license. See the licenses folder for more information.
+
+
+.. _astropy: http://www.astropy.org/
+.. _here: http://sbpy.readthedocs.io/en/latest/

docs/api/sbpy.activity.ActivityClass.rst

@@ -1,48 +1,21 @@
-
-
 ActivityClass
-===========================
+=============
 
 .. currentmodule:: sbpy.activity
 
 .. autoclass:: ActivityClass
    :show-inheritance:
 
-
-
-
-
-
-
-
-
-
-
-
    .. rubric:: Methods Summary
 
    .. autosummary::
-   
+
       ~ActivityClass.column_density
       ~ActivityClass.total_number
       ~ActivityClass.volume_density
 
-
-
-
-
-
-
-
-
-
-
    .. rubric:: Methods Documentation
 
-
    .. automethod:: column_density
    .. automethod:: total_number
    .. automethod:: volume_density
-
-
-

docs/api/sbpy.activity.Aperture.rst

@@ -1,46 +1,21 @@
-
-
 Aperture
-======================
+========
 
 .. currentmodule:: sbpy.activity
 
 .. autoclass:: Aperture
    :show-inheritance:
 
-
-
-
-
-
-
-
-
-
    .. rubric:: Methods Summary
 
    .. autosummary::
-   
+
       ~Aperture.circular
       ~Aperture.gaussian
       ~Aperture.rectangular
 
-
-
-
-
-
-
-
-
-
-
    .. rubric:: Methods Documentation
 
-
    .. automethod:: circular
    .. automethod:: gaussian
    .. automethod:: rectangular
-
-
-

docs/api/sbpy.activity.Haser.rst

@@ -1,29 +1,7 @@
-
-
 Haser
-===================
+=====
 
 .. currentmodule:: sbpy.activity
 
 .. autoclass:: Haser
    :show-inheritance:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

docs/api/sbpy.activity.Species.rst

@@ -1,44 +1,19 @@
-
-
 Species
-=====================
+=======
 
 .. currentmodule:: sbpy.activity
 
 .. autoclass:: Species
    :show-inheritance:
 
-
-
-
-
-
-
-
-
-
    .. rubric:: Methods Summary
 
    .. autosummary::
-   
+
       ~Species.fluorescence_length
       ~Species.scale_length
 
-
-
-
-
-
-
-
-
-
-
    .. rubric:: Methods Documentation
 
-
    .. automethod:: fluorescence_length
    .. automethod:: scale_length
-
-
-

docs/api/sbpy.activity.Syndynes.rst

@@ -1,44 +1,17 @@
-
-
 Syndynes
-======================
+========
 
 .. currentmodule:: sbpy.activity
 
 .. autoclass:: Syndynes
    :show-inheritance:
 
-
-
-
-
-
-
-
-
-
-
-
    .. rubric:: Methods Summary
 
    .. autosummary::
-
-      ~Syndynes.plot_syndynes
-
-
-
-
-
-
-
 
-
-
+      ~Syndynes.plot_syndynes
 
    .. rubric:: Methods Documentation
 
-
    .. automethod:: plot_syndynes
-
-
-

docs/api/sbpy.activity.Vectorial.rst

@@ -1,29 +1,7 @@
-
-
 Vectorial
-=======================
+=========
 
 .. currentmodule:: sbpy.activity
 
 .. autoclass:: Vectorial
    :show-inheritance:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-