Skip to content

Commit

Permalink
PR review fix
Browse files Browse the repository at this point in the history
  • Loading branch information
robelgeda committed Jan 6, 2020
1 parent 88fda28 commit 05ea278
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
7 changes: 7 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@ run reasonably quickly, and to make scene generation and observation as easy as
Developed by Brian York (`@york-stsci <https://github.com/york-stsci>`_) and
Robel Geda (`@robelgeda <https://github.com/robelgeda>`_).


.. warning::

STIPS JWST is no longer being actively developed except by inheriting updates to pandeia, webbpsf, and jbt
(i.e. STIPS will get new throughput information, any changes to the simulated PSFs, and any changes to the
simulated backgrounds). We do not test the JWST and HST portions of STIPS.

.. figure:: wfirst_figures/stips_demo.png

Fig. 1: Simulated WFI image of a star cluster and background galaxies.
Expand Down
14 changes: 10 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ STIPS Requirements
* `scipy`: STIPS uses scipy to manipulate its internal images (zoom and rotate).

Finally, STIPS requires a set of data files whose location is marked by setting the environment
variable `stips_data`. Currently these files are available as part of the STSCI-STIPS-UI GitHub
project, but they should eventually be made available as a (versioned) direct download.
variable `stips_data`. The current best form of stips_data is actually kept (and versioned) inside
the STIPS project itself.

Installing Using Conda and Source
##################################

STIPS can be installed using the source code and a Conda environment file.
If you do not have anaconda or miniconda installed, please visit the ` astroconda docs <https://astroconda.readthedocs.io/en/latest/getting_started.html#getting-started-jump>`_ for installation instructions.
If you do not have anaconda or miniconda installed, please visit the `astroconda docs <https://astroconda.readthedocs.io/en/latest/getting_started.html>`_ for installation instructions.
We have included a Conda environment file for easily installing or updating Conda packages to meet STIPS requirements.
Please follow the steps below to install STIPS:

Expand Down Expand Up @@ -105,6 +105,12 @@ You will need to download the data and add them to your environmental path

Make sure that you have the correct version number for `pandeia_refdata` (replace the "x.x").

.. note::
The URL we provide in this section and the suggested pandeia reference data directory name
are specifically for using STIPS with WFIRST. If you would like to use STIPS with JWST,
you need to download the regular pandeia reference data (and if you want to be able to use both,
you download both and either copy the 'wfirst' directory into the regular reference data, or the
'jwst' directory into the WFIRST reference data).

Testing Installation
*********************
Expand All @@ -129,7 +135,7 @@ Installing Using Docker
Installing
**********

1. Start by installing the free [Docker Community Edition](https://www.docker.com/community-edition) locally.
1. Start by installing the free `Docker Community Edition <https://www.docker.com/community-edition>`_ locally.
This will make the `docker` command available in your terminal. Note that after installing docker,
you must open the application once for docker to be available from the command line.

Expand Down

0 comments on commit 05ea278

Please sign in to comment.