Skip to content

Commit

Permalink
Add WFC3 notebook 'wfc3_exception_report.ipynb' (#102)
Browse files Browse the repository at this point in the history
* updated _toc.yml and _config.yml files

* Added trailing line to rad_prof.py.

* Created notebook-level requirements.txt file.

* wfc3_exception_report.ipynb: cleared all notebook outputs

* Update rad_prof.py for PEP8

changes for PEP8 compliance

* Update display_image.py for PEP8

edits for PEP8 compliance

* Update display_image.py for PEP8

changes for PEP8 compiance

* Update display_image.py for PEP8

🫠

* Update rad_prof.py for PEP8

final edits for PEP8 compliance

* Update wfc3_exception_report.ipynb for PEP8

changes for PEP8 compliance

* Update wfc3_exception_report.ipynb for PEP8

* Update wfc3_exception_report.ipynb for PEP8

hopefully final PEP8 changes. sorry im so bad at this 🫠

* Update requirements.txt

Removing pins for version numbers. Also removing ginga dependency since I'm having problems with it in Python 3.11. Instead, I'm going to use astropy.visualization's ZScaleInterval

* Update display_image.py

swapping ginga.util.zscale for astropy.visualization's ZScaleInterval

* Update wfc3_exception_report.ipynb

removed `ginga.util.zscale` dependence and replaced with `astropy.visualization`'s `ZScaleInterval`

* Update wfc3_exception_report.ipynb

second markdown table in section 6.1 wasn't formatted correctly

* Update README.md

removing the old environment installation instructions and replacing them with information about using the `requirements.txt` file

* Update README.md

adding line breaks

* Update wfc3_exception_report.ipynb

minor changes to make the code more robust and platform-independent

* Update wfc3_exception_report.ipynb

i added shutil to the imports but forgot to describe it in the import markdown table

---------

Co-authored-by: bjkuhn <bkuhn@stsci.edu>
  • Loading branch information
dulude and bjkuhn authored Nov 21, 2023
1 parent 31cbf7c commit 465c7e4
Show file tree
Hide file tree
Showing 7 changed files with 285 additions and 301 deletions.
1 change: 0 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ exclude_patterns: [notebooks/DrizzlePac/align_mosaics/align_mosaics.ipynb,
notebooks/DrizzlePac/use_ds9_regions_in_tweakreg/use_ds9_regions_in_tweakreg.ipynb,
notebooks/WFC3/calwf3_recalibration/calwf3_recal_tvb.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

0 comments on commit 465c7e4

Please sign in to comment.