Skip to content

Commit

Permalink
documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Mommert committed Aug 29, 2017
1 parent 6324f30 commit 1d96894
Show file tree
Hide file tree
Showing 8 changed files with 313 additions and 57 deletions.
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ prune astropy_helpers/build
prune astropy_helpers/astropy_helpers/tests


global-exclude *.pyc *.o
global-exclude *.pyc *.o
5 changes: 3 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ development of `sbpy` is currently pending.
Documentation
-------------

Documentation is available `here`_.
The official documentation is available `here`_.


Contributing
Expand Down Expand Up @@ -69,7 +69,7 @@ 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.
report. Please follow the `astropy code of conduct`_.



Expand All @@ -81,3 +81,4 @@ This project is Copyright (c) sbpy team and licensed under the terms of the BSD

.. _astropy: http://www.astropy.org/
.. _here: http://sbpy.readthedocs.io/en/latest/
.. _astropy conde of conduct: http://docs.astropy.org/en/latest/development/codeguide.html
85 changes: 39 additions & 46 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,51 +3,44 @@ SBPy Documentation

SBPy - A Python Module for Small-Body Planetary Astronomy

**Please note that this package is under heavy development. The current documentation is only intended to provide an outline for the API to be used in SBPy.**


Module Structure
----------------

We foresee the following module structure for `sbpy`:

.. figure:: static/structure.png
:alt: sbpy module structure

`sbpy` design schematic. Modules are shown as rectangular boxes,
important classes as rounded colored boxes. The left-hand side of
the schematic is mainly populated with support modules that act as
data containers and query functions. The right-hand side of the
schematic shows modules that focus on small body-related
functionality. Colored symbols match the colors and symbols of
classes and modules they are using.

The current status of the individual modules and code elements can be
inquired from the this :ref:`status page`.






API Outline
-----------
`sbpy` is a community effort to build a Python package for small-body
planetary astronomy in the form of an `astropy`_ affiliated package.

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.


Please note that this package is under heavy development. The current
documentation is only intended to provide an outline for the API to be
used in SBPy.

For an overview on the expected structure and functionality of `sbpy`,
please refer to `Module Structure <module structure>`_ page; the
`Status Page <Status Page>`_ provides an overview on the
implementation status of all modules and functions.


Content
-------

.. toctree::
:maxdepth: 1

structure.rst
status.rst
sbpy/index.rst

Note that this outline is not up-to-date. All structures are still in
development. Examples provide only a rough guideline to the intended
structure.

.. toctree::
:maxdepth: 1


sbpy/data.rst
sbpy/activity.rst
sbpy/photometry.rst
sbpy/shape.rst
sbpy/spectroscopy.rst
sbpy/imageanalysis.rst
sbpy/thermal.rst
sbpy/obsutil.rst
sbpy/bib.rst

26 changes: 21 additions & 5 deletions docs/sbpy/index.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,26 @@
******************
sbpy Documentation
******************
************************
`sbpy` API Documentation
************************

Note that this outline is not up-to-date. All structures are still in
development. Examples provide only a rough guideline to the intended
structure.

This is the documentation for sbpy.

Reference/API
=============

.. automodapi:: sbpy
.. toctree::
:maxdepth: 1

data.rst
activity.rst
photometry.rst
shape.rst
spectroscopy.rst
imageanalysis.rst
thermal.rst
obsutil.rst
bib.rst


1 change: 0 additions & 1 deletion docs/status.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
:orphan:
.. _status page:

Status Page
Expand Down

0 comments on commit 1d96894

Please sign in to comment.