Docs refresh (work-in-progress) #33
Merged
Conversation
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
Since the module docstring is used in the rendered HTML docs, it serves a different role from the README.
Include a link to GitHub issues in the troubleshooting instructions Report precision info for np.float and np.complex in diagnostic report
| For each of the five instruments (four SIs plus FGS) there are three provided OPD files. These represent wavefronts as follows: | ||
|
|
||
| 1. The OTE and ISIM intrinsic WFE | ||
| 2. The above, plus a slight defocus to blur the image slightly to approximate image motion. | ||
| 3. The above #2, plus additional WFE due to SI internal optics. | ||
|
|
||
| The latter is the largest WFE, and is the default file used in simulations unless another is explicitly chosen. For NIRCam only there is a second, duplicate | ||
| set of these files with slightly improved WFE based on an optimistic case scenario for instrument and telescope alignment. | ||
| The latter is the largest WFE, and is the default file used in simulations unless another is explicitly chosen. For NIRCam only there is a second, duplicate set of these files with slightly improved WFE based on an optimistic case scenario for instrument and telescope alignment. |
There was a problem hiding this comment.
We should probably add some text here as follows:
The provided OPDs are based on the observatory design requirements, and were developed for the Mission Critical Design Review. The represent the nominal case of performance for JWST, and have not yet been updated with as-built details of mirror surface figures, etc. We intend to make updated OPD files available once suitable reference data have been provided to STScI. For now, see Lightsey et al. 2014 <http://adsabs.harvard.edu/abs/2014SPIE.9143E..04L>_ for recent predictions of JWST's likely performance.
There was a problem hiding this comment.
Great, added! (Just noticed that the table wasn't compiling, so I fixed that too. Oops.)
| pyFFTW version: 0.9.2 | ||
|
|
||
| Floating point type information for numpy.float: | ||
| Machine parameters for float64 |
This was referenced Aug 28, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.