Skip to content

Commit

Permalink
Cleaned up README. Updated installation instruction.
Browse files Browse the repository at this point in the history
  • Loading branch information
pllim committed Apr 12, 2016
1 parent dd3d77e commit 6b12b15
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 35 deletions.
35 changes: 1 addition & 34 deletions README
Original file line number Diff line number Diff line change
@@ -1,34 +1 @@
This is a prototype module for manipulating spectra.
It is intended for it to be used for synthetic
photometry, i.e. constructing source spectra and
then passing these spectra through an astronomical
observatory (e.g. HST, JWST...).

Install the module the usual way:

python setup.py install

The spectrum manipulation module spectrum.py will work
standalone, whereas the observationmode.py module
is designed to work with the HST synphot database, so
won't be much use unless you also install these files.
(You don't need to install the synphot software; only its
datafiles.) You can get them from

http://www.stsci.edu/resources/software_hardware/stsdas/synphot

You must define the environment variable PYSYN_CDBS to point
to the top level directory where you have installed these files.

If you have questions about this module, send mail to
help@stsci.edu and it will get to the appropriate
person.

.....

The current revision is $Rev$.

It has the following dependencies:
- numpy v1.0 or higher
- PyFITS v1.1 or higher
- matplotlib v0.9 or higher
For full documentation, please see http://ssb.stsci.edu/pysynphot/docs/ .
9 changes: 8 additions & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ 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/>`_ (not recommended).
`standalone <https://github.com/spacetelescope/pysynphot/releases>`_
(`its PyPI distribution <https://pypi.python.org/pypi/pysynphot/>`_ is no
longer supported).
Although this package was developed for HST, it can be utilized with other
observatories.

Expand Down Expand Up @@ -57,6 +59,11 @@ Unless you are using Ureka, the following dependencies must be installed first:
* `numpy <https://pypi.python.org/pypi/numpy>`_ 1.7 or greater
* `matplotlib <http://matplotlib.org/>`_ (optional)

To install the
`standalone <https://github.com/spacetelescope/pysynphot/releases>`_ release::

pip install https://github.com/spacetelescope/pysynphot/archive/0.9.8.2.zip

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

Data files for **pysynphot** are distributed separately by
Expand Down

0 comments on commit 6b12b15

Please sign in to comment.