Skip to content

Commit

Permalink
Prettify README [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Joseph Long committed Sep 30, 2016
1 parent 1bb966d commit 34f9849
Show file tree
Hide file tree
Showing 3 changed files with 267 additions and 25 deletions.
49 changes: 24 additions & 25 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,36 +1,35 @@
WebbPSF: Simulated Point Spread Functions for the James Webb Space Telescope
============================================================================
WebbPSF: Simulated Point Spread Functions for JWST and WFIRST
=============================================================

.. image:: docs/figures/readme_fig.png

.. image:: https://img.shields.io/pypi/v/webbpsf.svg
:target: https://pypi.python.org/pypi/webbpsf
:alt: Badge showing current released PyPI version

.. image:: https://coveralls.io/repos/github/mperrin/webbpsf/badge.svg?branch=master
:target: https://coveralls.io/github/mperrin/webbpsf?branch=master

.. image:: https://coveralls.io/repos/mperrin/webbpsf/badge.svg
:target: https://coveralls.io/r/mperrin/webbpsf
:alt: Badge showing testing code coverage percentage

WebbPSF produces simulated PSFs for the James Webb Space Telescope, NASA's next
flagship infrared space telescope. WebbPSF can simulate images for any of the
four science instruments plus the fine guidance sensor, including both direct
imaging and coronagraphic modes.

Developed by Marshall Perrin, Joseph Long, and collaborators, 2010-2015.
WebbPSF also supports simulating PSFs for the proposed Wide-Field Instrument
for the upcoming WFIRST mission, including variation of the PSF within and
among the eighteen detectors.

Developed by Marshall Perrin, Joseph Long, and collaborators, 2010-2016.

Documentation can be found online at https://pythonhosted.org/webbpsf/

WebbPSF requires a large amount of input data for its simulations, including
optical path difference (OPD) maps, filter transmission curves, and coronagraph
Lyot mask shapes. These data files are not included in this source distribution.
WebbPSF requires input data for its simulations, including optical path
difference (OPD) maps, filter transmission curves, and coronagraph Lyot mask
shapes. These data files are not included in this source distribution.
Please see the documentation to download the required data files.

This is intended to be an `Astropy <http://astropy.org/>`_ affiliated package.


Status reports for developers
-----------------------------

.. image:: https://pypip.in/v/webbpsf/badge.png
:target: https://pypi.python.org/pypi/webbpsf

.. image:: https://pypip.in/d/webbpsf/badge.png
:target: https://pypi.python.org/pypi/webbpsf

.. image:: https://travis-ci.org/mperrin/webbpsf.png?branch=master
:target: https://travis-ci.org/mperrin/webbpsf
:alt: Test Status

.. image:: https://coveralls.io/repos/mperrin/webbpsf/badge.svg
:target: https://coveralls.io/r/mperrin/webbpsf
:alt: Test Coverage
*This is intended to be an* `Astropy <http://astropy.org/>`_ *affiliated package.*
243 changes: 243 additions & 0 deletions docs/README figure.ipynb

Large diffs are not rendered by default.

Binary file added docs/readme_fig.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 34f9849

Please sign in to comment.