diff --git a/docs/index.rst b/docs/index.rst index 7905d61..a15b333 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,6 +26,13 @@ run reasonably quickly, and to make scene generation and observation as easy as Developed by Brian York (`@york-stsci `_) and Robel Geda (`@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. diff --git a/docs/installation.rst b/docs/installation.rst index 31fb018..d1da01e 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -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 `_ for installation instructions. +If you do not have anaconda or miniconda installed, please visit the `astroconda docs `_ 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: @@ -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 ********************* @@ -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 `_ 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.