Skip to content
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

Add WFC3 notebook 'wfc3_exception_report.ipynb' #102

Merged
merged 20 commits into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ exclude_patterns: [notebooks/DrizzlePac/align_mosaics/align_mosaics.ipynb,
notebooks/WFC3/calwf3_recalibration/calwf3_recal_tvb.ipynb,
notebooks/WFC3/calwf3_v1.0_cte/calwf3_with_v1.0_PCTE.ipynb,
notebooks/WFC3/dash/dash.ipynb,
notebooks/WFC3/exception_report/wfc3_exception_report.ipynb,
notebooks/WFC3/filter_transformations/filter_transformations.ipynb,
notebooks/WFC3/flux_conversion_tool/flux_conversion_tool.ipynb,
notebooks/WFC3/image_displayer_analyzer/wfc3_image_displayer_analyzer.ipynb,
Expand Down
2 changes: 1 addition & 1 deletion _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ parts:
# - file: notebooks/WFC3/calwf3_recalibration/calwf3_recal_tvb.ipynb
# - file: notebooks/WFC3/calwf3_v1.0_cte/calwf3_with_v1.0_PCTE.ipynb
# - file: notebooks/WFC3/dash/dash.ipynb
# - file: notebooks/WFC3/exception_report/wfc3_exception_report.ipynb
- file: notebooks/WFC3/exception_report/wfc3_exception_report.ipynb
# - file: notebooks/WFC3/filter_transformations/filter_transformations.ipynb
# - file: notebooks/WFC3/flux_conversion_tool/flux_conversion_tool.ipynb
# - file: notebooks/WFC3/image_displayer_analyzer/wfc3_image_displayer_analyzer.ipynb
Expand Down
21 changes: 12 additions & 9 deletions notebooks/WFC3/exception_report/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,22 @@ when an observer receives a WFC3 Exception Report Email.

This directory, once downloaded, should contain this README.md, the tutorial
Jupyter Notebook `wfc3_exception_report.ipynb`, an `html` copy of the notebook,
and a subdirectory titled `docs`. The subdirectory should contain two `.py`
files, one `.png`, and one `.gif` file that are used in the notebook.
a `requirements.txt` file, and a subdirectory titled `docs`. The subdirectory
should contain two `.py` files, one `.png`, and one `.gif` file that are used
in the notebook.

In order to run this Jupyter Notebook, you must have created a virtual
environment, such as the one in [WFC3 Library's](https://github.com/spacetelescope/WFC3Library) installation instructions. If
you are using the `wfc3_env` environment from the `wfc3_env_legacy.yml` file in the
WFC3Library repository, then you should not need any other packages to run this
notebook.
To run this Jupyter Notebook, you must have created a virtual environment
that contains (at minimum) the packages listed in the `requirements.txt` file
that is included within the repository. We recommend creating a new conda
environment using the requirements file:

`$ conda create -n except_report python=3.11` <br>
`$ conda activate except_report` <br>
`$ pip install -r requirements.txt`<br>

Optional Note: The tools in this notebook (specifically display_image) look much
better in Jupyter Lab rather than in the classic Jupyter Notebook. If your
environment has Jupyter Lab installed it's recommended you use that to run the
.ipynb file. If you're interested in adding Jupyter Lab to your environment see
the install instructions on the [Jupyter website](https://jupyter.org/install).
.ipynb file. See the [Jupyter website](https://jupyter.org/install) for more info.

Please submit any questions or comments to the [WFC3 Help Desk](https://stsci.service-now.com/hst).
Loading
Loading