-
Notifications
You must be signed in to change notification settings - Fork 62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
WebbPSF to STPSF #951
Open
BradleySappington
wants to merge
13
commits into
develop
Choose a base branch
from
webbpsf_to_stpsf
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
WebbPSF to STPSF #951
Changes from 7 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
ecf2002
import stpsf
BradleySappington 2ede7a0
update workflow
BradleySappington 8142535
read the docs redirect
BradleySappington 202371f
remove webbpsf conftest.py
BradleySappington 7374e06
update workflows
BradleySappington 31fa455
simplify tox
BradleySappington cfad72e
remove workflows
BradleySappington a4247d5
update warning
BradleySappington 3e13ca5
update warning
BradleySappington 3c1936b
only warn once
BradleySappington f35f759
spelling
BradleySappington 53806a8
Simplify warning
BradleySappington 320da5d
update warning
BradleySappington File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,113 +1,2 @@ | ||
Documentation for WebbPSF | ||
=============================== | ||
|
||
WebbPSF is a Python package that computes simulated point spread functions (PSFs) for NASA's James Webb Space Telescope (JWST) and Nancy Grace Roman Space Telescope. WebbPSF transforms models of telescope and instrument optical state into PSFs, taking into account detector pixel scales, rotations, filter profiles, and point source spectra. It is rather a tool for transforming optical path difference (OPD) maps, created with observatory systems engineering models, into the resulting PSFs as observed with JWST's or Roman's instruments. | ||
|
||
.. figure:: ./fig_instrument_comparison.png | ||
:scale: 45 % | ||
:align: center | ||
:alt: Sample PSFs for JWST's instruments. | ||
|
||
Sample PSFs for JWST's instrument suite, all on the same angular scale and display stretch. | ||
|
||
.. figure:: ./roman_figures/webbpsf-roman_page_header.png | ||
:scale: 70 % | ||
:align: center | ||
:alt: Sample PSFs for the filters in the Roman WFI. | ||
|
||
Sample PSFs for the filters in the Roman WFI on SCA01. Note that | ||
the prism and grism PSFs shown here are monochromatic. | ||
|
||
|
||
**Contributors:** | ||
WebbPSF has been developed by Marshall Perrin, Marcio Meléndez, Shannon Osborne, Robel Geda, Brad Sappington, Charles-Philippe Lajoie, Joseph Long, Justin Otor, Jarron Leisenring, Neil Zimmerman, Keira Brooks, and Anand Sivaramakrishnan, with contributions from Alden Jurling, Lauren Chambers, Ewan Douglas, and `others <https://github.com/spacetelescope/webbpsf/graphs/contributors>`_. | ||
|
||
Getting Started with WebbPSF | ||
---------------------------- | ||
|
||
See `Using WebbPSF <usage.html>`_. | ||
|
||
.. admonition:: Quickstart Jupyter Notebook | ||
|
||
This documentation is complemented by an `Jupyter Notebook format quickstart tutorial <http://nbviewer.jupyter.org/github/spacetelescope/webbpsf/blob/stable/notebooks/WebbPSF_tutorial.ipynb>`_. Downloading and running that notebook is a great way to get started using WebbPSF. | ||
|
||
|
||
.. admonition:: Getting Help | ||
|
||
For help using or installing webbpsf, you can contact the STScI JWST Help Desk at jwsthelp.stsci.edu, category WebbPSF/JWST Telescope. | ||
|
||
|
||
:ref:`What's new in the latest release? <whatsnew>` | ||
|
||
Contents | ||
-------- | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Getting Started | ||
|
||
intro.rst | ||
installation.rst | ||
relnotes.rst | ||
usage.ipynb | ||
psf_grids.ipynb | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Modeling JWST PSFs | ||
|
||
jwst.rst | ||
more_examples.rst | ||
jwst_measured_opds.ipynb | ||
jwst_detector_effects.ipynb | ||
jwst_matching_psfs_to_data.ipynb | ||
jwst_ifu_datacubes.ipynb | ||
jwst_large_psf.ipynb | ||
jwst_optical_budgets.ipynb | ||
jwst_psf_subtraction.ipynb | ||
jwst_wavefront_deltas.ipynb | ||
less_common_usage.rst | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Modeling Roman PSFs | ||
|
||
roman.rst | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Package Documentation | ||
|
||
api_reference.rst | ||
help.rst | ||
sampling.rst | ||
fft_optimization.rst | ||
poppy.rst | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Developer Reference | ||
|
||
available_opds.rst | ||
field_dependence/multifield_documentation.ipynb | ||
references.rst | ||
release.rst | ||
|
||
|
||
.. admonition:: How to cite WebbPSF | ||
|
||
In addition to this documentation, WebbPSF is described in the following references. Users of WebbPSF are encouraged to cite one of these. | ||
|
||
* Perrin et al. 2014, `"Updated point spread function simulations for JWST with WebbPSF" <http://adsabs.harvard.edu/abs/2014SPIE.9143E..3XP>`_, Proc. SPIE. 9143, | ||
* Perrin et al. 2012, `"Simulating point spread functions for the James Webb Space Telescope with WebbPSF", <http://adsabs.harvard.edu/abs/2012SPIE.8442E..3DP>`_ Proc SPIE 8842, and | ||
* Perrin 2011, `Improved PSF Simulations for JWST: Methods, Algorithms, and Validation <Improved_PSFs_for_Webb.pdf>`_, JWST Technical report JWST-STScI-002469. | ||
|
||
In particular, the 2012 SPIE paper gives a broad overview, the 2014 SPIE paper presents comparisons to instrument cryotest data, and the Technical Report document describes in more detail the relevant optical physics, explains design decisions and motivation for WebbPSF's architecture, and presents extensive validation tests demonstrating consistency between WebbPSF and other PSF simulation packages used throughout the JWST project. | ||
|
||
|
||
* :ref:`genindex` | ||
* :ref:`search` | ||
|
||
**Mailing List** | ||
|
||
If you would like to receive email announcements of future versions, please contact Marshall Perrin, or visit `maillist.stsci.edu <https://maillist.stsci.edu/scripts/wa.exe?SUBED1=webbpsf-users&A=1>` to subscribe yourself to the "[email protected]" list. | ||
.. meta:: | ||
:http-equiv=Refresh: 0; url='https://stpsf.readthedocs.io/en/latest/' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't seem right to me to remove all test environments apart from the docs.
We're still going to have the
webbpsf
package as a wrapper that importsstpsf
, and being able to doimport webbpsf
and have existing code run is a KEY PART of the intended functionality here.Therefore there needs to be a test suite that verifies that we can indeed
import webbpsf
and run calculations.So please let's keep at least one test environment that runs the existing full test suite of webbpsf test functions. I don't think this needs to have all the different instances in the test matrix -- those will be covered by the stpsf test suite -- but there should be enough here to test that the import wrapper is working as intended.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Context for removing all the test environments:
Because the entire repository is replaced with stpsf, the tests that are running are stpsf tests. This wasn't playing nicely with our CI as all tests labelled webbpsf no longer existed. As this was intended to be the final release of WebbPSF, I decided to manually verify that the init change worked properly (as these automated tests will not need to run in the future because development is stopping in this repository). I think that if we all take a look and are comfortable with testing the build manually, that suffices. If this makes anyone uncomfortable I can spend time trying to get the CI functional, however I felt the benefits of that time investment were minimal.