Skip to content

Commit

Permalink
Minor updates to pysynphot doc
Browse files Browse the repository at this point in the history
git-svn-id: https://aeon.stsci.edu/ssb/svn/astrolib/trunk/pysynphot@5466 90a0a646-be8a-0410-bb88-9290da87bc01
  • Loading branch information
pllim committed Feb 22, 2016
1 parent 6ee2267 commit dd3d77e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
8 changes: 4 additions & 4 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,16 @@

# General information about the project.
project = u'pysynphot'
copyright = u'2015, STScI'
copyright = u'2016, STScI'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.9.7'
version = pysynphot.__version__
# The full version, including alpha/beta/rc tags.
release = '0.9.7.dev'
release = version.replace('.dev', '')

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -98,7 +98,7 @@
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
modindex_common_prefix = ['pysynphot.']


# -- Options for HTML output ---------------------------------------------------
Expand Down
13 changes: 10 additions & 3 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ object-oriented replacement for STSDAS SYNPHOT synthetic photometry package in
IRAF. It is distributed as part of
`stsci_python <http://www.stsci.edu/institute/software_hardware/pyraf/stsci_python/>`_,
`Ureka <http://ssb.stsci.edu/ureka/>`_, and also as
`standalone <https://pypi.python.org/pypi/pysynphot/>`_.
`standalone <https://pypi.python.org/pypi/pysynphot/>`_ (not recommended).
Although this package was developed for HST, it can be utilized with other
observatories.

Expand All @@ -38,6 +38,13 @@ control and data structures available in Python to easily perform repetitive
operations such as simulate the observation of multiple type of sources through
multiple observing modes.

If you use **pysynphot** in your work, please cite it as,
"*Lim, P. L., Diaz, R. I., & Laidler, V. 2015, PySynphot User's Guide
(Baltimore, MD: STScI), http://ssb.stsci.edu/pysynphot/docs/*"

If you have questions or concerns regarding the software, please contact
STScI Help Desk via ``help[at]stsci.edu``.


.. _pysynphot-installation-setup:

Expand All @@ -46,11 +53,11 @@ Installation and Setup

Unless you are using Ureka, the following dependencies must be installed first:

* `astropy <https://pypi.python.org/pypi/astropy>`_ 1.0 or greater
* `numpy <https://pypi.python.org/pypi/numpy>`_ 1.7 or greater
* `pyfits <https://pypi.python.org/pypi/pyfits>`_ 3.2 or greater
* `matplotlib <http://matplotlib.org/>`_ (optional)

**pysynphot** is currently incompatible with Python 3. Please use Python 2.7.
**pysynphot** is not fully tested under Python 3. Please use Python 2.7.

Data files for **pysynphot** are distributed separately by
`Calibration Reference Data System <http://www.stsci.edu/hst/observatory/crds/throughput.html>`_.
Expand Down

0 comments on commit dd3d77e

Please sign in to comment.