.. _installation: Requirements & Installation =========================== .. note:: This is entirely optional, but you may wish to sign up to the mailing list ``webbpsf-users@maillist.stsci.edu``. This is a very low-traffic moderated announce-only list, to which we will periodically post announcements of updates to this software. To subscribe, visit the `maillist.stsci.edu server `_ .. NOTE: installation with conda is unavailable as of v1.1.0. uncomment and edit the following section once it's back. .. _install_with_conda: Recommended: Installing with conda ---------------------------------- If you already use ``conda``, but do not want to install the full suite of STScI software, you can simply add the AstroConda *channel* and install WebbPSF as follows (creating a new environment named ``webbpsf-env``):: $ conda config --add channels http://ssb.stsci.edu/astroconda $ conda create -n webbpsf-env webbpsf $ conda activate webbpsf-env Upgrading to the latest version is done with ``conda update -n webbpsf-env --all``. .. warning:: You *must* install WebbPSF into a specific environment (e.g. ``webbpsf-env``); our conda package will not work if installed into the default "root" environment. .. _install_pip: Installing with pip ------------------- WebbPSF and its underlying optical library POPPY may be installed from the `Python Package Index `_ in the usual manner for Python packages. :: $ pip install --upgrade webbpsf [... progress report ...] Successfully installed webbpsf Note that ``pip install webbpsf`` only installs the program code. **If you install via pip, you must manually download and install the data files, as** :ref:`described ` **below.** To obtain source spectra for calculations, you should also follow :ref:`installation instructions for synphot `. .. note:: Installation through conda is not available as of WebbPSF version 1.1.0. Conda users should instead follow the insructions in the preceding section to install via pip. .. _synphot_install: Installing or updating synphot -------------------------------- Stsynphot is an optional dependency, but is highly recommended. Its installation instructions can be found in `the synphot docs `_ or `a discussion in the POPPY docs `_. .. _data_install: Installing the Required Data Files ---------------------------------- *If you install via pip or manually*, you must install the data files yourself. .. (If you install via Conda, the data files are automatically installed, in which case you can skip this section.) [uncomment once conda installation is available again] Files containing such information as the JWST pupil shape, instrument throughputs, and aperture positions are distributed separately from WebbPSF. To run WebbPSF, you must download these files and tell WebbPSF where to find them using the ``WEBBPSF_PATH`` environment variable. 1. Download the following file: `webbpsf-data-1.2.1.tar.gz `_ [approx. 70 MB] 2. Untar ``webbpsf-data-1.2.1.tar.gz`` into a directory of your choosing. 3. Set the environment variable ``WEBBPSF_PATH`` to point to that directory. e.g. :: export WEBBPSF_PATH=$HOME/data/webbpsf-data for bash. (You will probably want to add this to your ``.bashrc``.) You should now be able to successfully ``import webbpsf`` in a Python session. .. warning:: If you have previously installed the data files for an earlier version of WebbPSF, and then update to a newer version, the software may prompt you that you must download and install a new updated version of the data files. .. Note:: **For STScI Users Only:** Please note, we are no longer providing users at STScI a location with the required data files on the Central Storage network. Therefore, to run WebbPSF, you must download these files and tell WebbPSF where to find them using the WEBBPSF_PATH environment variable. Software Requirements --------------------- See `the requirements.txt specification file `_ for the required package dependencies. **Required Python version**: WebbPSF 1.1 and above require Python 3.9 or higher. The major dependencies are the standard `NumPy, SciPy `_, `matplotlib `_ stack, and `Astropy `_. **Recommended Python packages**: * `synphot `_ enables the simulation of PSFs with proper spectral response to realistic source spectra. Without this, PSF fidelity is reduced. See above for :ref:`installation instructions for synphot `. Stsynphot is recommended for most users. **Optional Python packages**: Some calculations with POPPY can benefit from the optional packages `psutil `_ and `pyFFTW `_, but these are not needed in general. See `the POPPY installation docs `_ for more details. These optional packages are only worth adding for speed improvements if you are spending substantial time running calculations. Additional packages are needed for the optional use of GPUs to accelerate calculations. See the POPPY documentation. .. _install_dev_version: Installing a pre-release version or contributing to WebbPSF development ----------------------------------------------------------------------- The `WebbPSF source code repository `_ is hosted at GitHub, as is the repository for `POPPY `_. Users may clone or fork in the usual manner. Pull requests with code enhancements welcomed. To install the current development version of WebbPSF, you can use ``pip`` to install directly from a ``git`` repository. To install WebbPSF and POPPY from ``git``, uninstall any existing copies of WebbPSF and POPPY, then invoke pip as follows:: $ pip install -e git+https://github.com/spacetelescope/poppy.git#egg=poppy \ -e git+https://github.com/spacetelescope/webbpsf.git#egg=webbpsf This will create directories ``./src/poppy`` and ``./src/webbpsf`` in your current directory containing the cloned repository. If you have commit access to the repository, you may want to clone via ssh with a URL like ``git+ssh://git@github.com:spacetelescope/webbpsf.git``. Documentation of the available options for installing directly from Git can be found in the `pip documentation `_. Remember to :ref:`install the required data files `, if you have not already installed them.