From d93431aec27526b6306fee2cec4835bd9607f67e Mon Sep 17 00:00:00 2001 From: obiwan76 Date: Mon, 13 Jan 2025 18:07:45 -0500 Subject: [PATCH] added some text to address comments about users installing in their library --- docs/webbpsf_to_stpsf.ipynb | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/webbpsf_to_stpsf.ipynb b/docs/webbpsf_to_stpsf.ipynb index 19c395a..1f063c4 100644 --- a/docs/webbpsf_to_stpsf.ipynb +++ b/docs/webbpsf_to_stpsf.ipynb @@ -14,14 +14,16 @@ "id": "cb664a9c-44f8-42f3-b12b-9897fdc4507a", "metadata": {}, "source": [ - "To reflect its broader support for Roman as well as James Webb, WebbPSF functionality has now migrated to STPSF (Space Telescope PSF). STPSF functionality is currently the same as WebbPSF, only the name is different. WebbPSF is now an alias of STPSF and is running code from the STPSF library\n", + "To reflect its broader support for Roman as well as James Webb, WebbPSF functionality has now migrated to STPSF (Space Telescope PSF). STPSF functionality is currently the same as WebbPSF, only the name is different. WebbPSF is now an alias of STPSF and is running code from the STPSF library. Therefore, the versioning \n", + "\n", "\n", "If you decided to make the change this notebook will help you explore the best options in order to transition your WebbPSF scritps and codes into STPSF. Generally speaking there are two options:\n", "- `import stpsf as webbpsf`. This can be done at the begining of your code and it will keep your code as-is, presenrving WebbPSF syntax to function calls.\n", "- `import stpsf`. In this case you will fully transition to the STPSF usage, thus, you need to replace all the WebbPSF calls to STPSF.\n", "\n", "\n", - "Note that in both cases you'll be required to install STPSF, including downloading the STPSF data files and setting a STPSF_PATH environment variable. See instructions under [Requirements & Installation](https://stpsf.readthedocs.io/en/latest/installation.html#requirements-installation). " + "Note that in both cases you'll be required to install STPSF, including downloading the STPSF data files and setting a STPSF_PATH environment variable. See instructions under [Requirements & Installation](https://stpsf.readthedocs.io/en/latest/installation.html#requirements-installation). The same applies if you are installing WebbPSF for your library via requirements.txt or pyproject.toml, then you should replace WebbPSF with STPSF.\n", + "\n" ] }, {