Skip to content

Commit

Permalink
Merge pull request #54 from sosey/release
Browse files Browse the repository at this point in the history
Updates to the logo and text errors in the docs
  • Loading branch information
sosey committed Jun 16, 2016
2 parents 561ab09 + ee572d4 commit 5606893
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 7 deletions.
5 changes: 2 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ imexam
:target: https://coveralls.io/github/spacetelescope/imexam?branch=master
:alt: Test Coverage Status

imexam is an `AstroPy`_ affiliated package meant for quick image analysis, or plotting, much like the older IRAF imexamine task.
Image display is currently supported with either DS9 or a Ginga widget from a python session, however it's also possible to use imexam
as a library of functions which produce standardized plots from the command line given an image and a location.

imexam is an affiliated package of `AstroPy`_. It was designed to be a lightweight library which enables users to explore data from a command line interface, through a Jupyter notebook or through a Jupyter console. It can be used with multiple viewers, such as DS9 or Ginga, or without a viewer as a simple library to make plots and grab quick photometry information.

For more information please see the `online documentation <http://imexam.readthedocs.io/>`_

Expand Down
Binary file modified docs/_static/imexam_logo_trans.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 9 additions & 1 deletion docs/imexam/description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,16 @@ These are some tips on installing the package, or tracking down problems you mig
python setup.py install


If you want to have access to the photometry features of the ``imexam`` analysis, download and install ``photutils`` - another of the astropy associated packages. The full list of astropy packages can be found here: https://github.com/astropy
``imexam`` can also be installed using pip or conda, and is included in the Astroconda distribution from STScI:

pip install imexam
pip install --upgrade imexam #if you already have an older version installed

conda install imexam



If you want to have access to the photometry features of the ``imexam`` analysis, download and install ``photutils`` - another of the astropy associated packages. The full list of astropy packages can be found here: https://github.com/astropy
If ``photutils`` is not installed, ``imexam`` should issue a nice statement saying that the photometry options are not available upon import, and any time an analysis key is pressed during the imexam() function loop which requires ``photutils`` to render a result.


Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Reporting Issues
================

If you have found a bug in ``imexam`` please report it by creating a
new issue on the ``imexam`` GitHub issue tracker
new issue on the ``imexam`` `GitHub issue tracker
<https://github.com/spacetelescope/imexam/issues>`_.

Please include an example that demonstrates the issue that will allow
Expand Down
5 changes: 3 additions & 2 deletions imexam/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,12 @@ def list_active_ds9():

def display_help():
""" display local html help in a browser window"""
url = "http://imexam.readthedocs.io/imexam/"
url = "http://imexam.readthedocs.io/"
try:
import webbrowser
# grab the version that's installed
url += "en/{0:s}/".format(__version__)
if "dev" not in __version__:
url += "en/{0:s}/".format(__version__)
webbrowser.open(url)
except ImportError:
warnings.warn(
Expand Down

0 comments on commit 5606893

Please sign in to comment.